ユーザーを削除するアクションの作成

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む5読むのに数分
  • SaaS アプリケーションでユーザーアカウントを非アクティブ化または削除するアクションを作成します。

    始める前に

    既存の ServiceNow® 統合ハブ スポークを使用している場合は、ユーザーを作成する代わりに使用できるユーザーを削除するアクションがあるかどうかを確認します。

    必要なロール:flow_designer または admin

    このタスクについて

    このアクションは、未使用のサブスクリプションを再利用して会社のソフトウェア経費を削減するために使用されます。

    手順

    1. 移動先 すべて > Flow Designer > デザイナー.
    2. [ 新規 ] をクリックし、[ アクション] を選択します。
    3. フォームのフィールドに入力します。
      表 : 1. アクションプロパティフォーム
      フィールド
      名前 任意の名前。たとえば、[ ユーザーを削除] などです。
      アクセス可能 すべてのアプリケーションスコープ
      カテゴリ このフィールドは空のままにします。
      保護 なし
      アプリケーション SaaS アプリケーションと統合するスポークアプリ。これは、既存の 統合ハブ スポークでも、作成した新しいスポークでもかまいません。
      インフロー注釈 このフィールドは空のままにします。
      説明 選択内容の説明。
    4. [送信] をクリックします。
    5. 「アクション・アウトライン」の「入力」セクションで、「 入力の作成」をクリックします。
    6. ユーザー ID 入力を追加します。

      これは、アクションが削除するユーザーのユーザー ID を取得する方法です。

      表 : 2. 入力
      ラベル 名前 タイプ 必須
      ユーザー ID userID 文字列 はい
    7. 使用している API が要求にユーザー認証を必要とする場合は、認証用の入力を追加します。
      一般的なユーザー認証入力の例は、管理者ユーザー ID とサイト名です。特定のケースでのユーザー認証の要件については、選択した API のドキュメントを参照してください。API がアクセストークンを必要とする場合、 資格情報値 変数は後で自動的に作成されるため、入力として追加する必要はありません。

      完了したアクションをサブフローで使用する場合は、これらの入力として渡す値を定義します。

    8. アクションアウトラインに SOAP ステップ または REST ステップ を追加します。
      どちらを選択するかは、統合する SaaS アプリケーションの API によって異なります。
    9. [SOAP] を選択した場合は、次のようにフォームに入力します。
      表 : 3. SOAP ステップフォーム
      フィールド
      接続の詳細
      接続 接続エイリアスを使用
      接続エイリアス 統合プロファイルを作成したときに作成した接続エイリアス。統合プロファイルをまだ作成していない場合は、手順に従って接続 エイリアスを使用してカスタム統合プロファイルを作成します。
      エンドポイント この値は、接続エイリアスを選択すると自動的に入力されます。エイリアスにリンクされた HTTP(s) 接続レコードからの接続 URL に設定されます。
      要求の詳細
      エンベロープの作成 手動で。
      SOAP アクション ユーザーを削除または非アクティブ化するための API 要求。選択した API のドキュメントを参照して、適切な要求を選択してください。
      SOAP エンベロープ ユーザーを削除するための XML 要求メッセージ。XML 要求メッセージの記述方法については、選択した API のドキュメントを参照してください。一般に、ヘッダーには、ユーザー認証用の入力変数と、アクセストークンとしての 認証情報値 変数が必要です。本文には、ユーザーの削除要求とユーザー ID の入力を含める必要があります。
      注:
      SOAP エンベロープの例については、「サブスクリプションの再利用」サブフローで使用される Webex 「ユーザーを削除」アクションを参照してください。
    10. [REST] を選択した場合は、次のようにフォームに入力します。
      表 : 4. REST ステップフォーム
      フィールド
      接続の詳細
      接続 接続エイリアスを使用
      接続エイリアス 統合プロファイルを作成したときに作成した接続エイリアス。統合プロファイルをまだ作成していない場合は、手順に従って接続 エイリアスを使用してカスタム統合プロファイルを作成します。
      ベース URL この値は、接続エイリアスを選択すると自動的に入力されます。エイリアスにリンクされた HTTP(s) 接続レコードからの接続 URL に設定されます。
      要求の詳細
      ビルド要求 手動で。
      リソース パス リソースへのパス。この値はベース URL に追加されます。リソースパスの構築方法については、使用している API のドキュメントを参照してください。
      HTTP メソッド DELETEです。
      クエリ パラメーター ユーザー ID のパラメーターを追加します。ユーザー ID 入力として値を設定します。
    11. エラー処理のために [アクションアウトライン] に スクリプトステップ を追加します。
      1. [必須ランタイム] フィールドで [インスタンス] を選択します。
      2. 入力変数を作成します。
        表 : 5. 入力変数
        名前
        response SOAP または REST ステップからの応答本文出力
        status_code SOAP または REST ステップから出力されるステータスコード
      3. 出力変数を作成します。
        表 : 6. 出力変数
        ラベル 名前 タイプ 必須
        status status 選択肢 はい
        error_message error_message 文字列 はい
      4. [ スクリプト] フィールドに、ステータスとエラーメッセージの出力に値を割り当てるスクリプトを記述します。
        • status_code入力を使用して、エラーがあるかどうかを確認します。ステータス出力 を、エラー がある場合はエラー、エラーがなければ 成功 に設定します。
        • エラーが発生した場合は、 応答 入力を使用してエラーの種類に関する情報を取得します。ユーザーが何が問題なのかを理解できるように、 エラーメッセージ 出力をエラーの説明に設定します。
    12. [アクションアウトライン] で、[出力] をクリックします。
    13. 出力変数を作成します。
      表 : 7. 出力変数
      ラベル 名前 タイプ 必須
      ステータス status 選択肢 いいえ
      エラーメッセージ error_message 文字列 いいえ
    14. 出力変数に値を割り当てます。
      表 : 8. 出力変数
      ラベル
      ステータス ステータス スクリプトステップからの出力変数
      エラーメッセージ スクリプトステップからの出力変数error_message
    15. アクションをテストするには、「 テスト」をクリックします。
      1. エラーの詳細については、テスト結果とシステムログを表示します。
        システムログを表示するには、次の場所に移動します。 システムログ > システムログ > すべて.
      2. アクションにエラーが発生した場合は、正しいエンドポイントを使用していることと、API 要求が想定どおりに構成されていることを確認してください。
      注:
      テストの際は、このアクションによってユーザーが非アクティブ化されることに注意してください。準本番環境でこのアクションをテストします。本番環境のみが利用可能な場合は、テスト用に偽のユーザーを作成できます。
    16. アクションが期待どおりに動作していることを確認したら、「 公開」をクリックします。