ユーザーを削除するアクションの作成
SaaS アプリケーションでユーザーアカウントを非アクティブ化または削除するアクションを作成します。
始める前に
既存の ServiceNow® 統合ハブ スポークを使用している場合は、ユーザーを作成する代わりに使用できるユーザーを削除するアクションがあるかどうかを確認します。
必要なロール:flow_designer または admin
このタスクについて
このアクションは、未使用のサブスクリプションを再利用して会社のソフトウェア経費を削減するために使用されます。
手順
- 次のように移動する。 All (すべて) > Flow Designer (フローデザイナー) > デザイナー.
- [新規] をクリックし、[アクション] を選択します。
-
フォームのフィールドに入力します。
表 : 1. アクションプロパティフォーム フィールド 値 [Name (名前)] 任意の名前。たとえば、[ ユーザーを削除] などです。 アクセス可能 すべてのアプリケーションスコープ。 カテゴリ このフィールドは空のままにします。 保護 なし。 アプリケーション SaaS アプリケーションと統合するためのスポークアプリ。これは、既存の 統合ハブ スポークでも、作成した新しいスポークでもかまいません。 インフロー注釈 このフィールドは空のままにします。 説明 任意の説明。 - [Submit (送信)] を選択します。
- [アクションアウトライン] の [入力] セクションで、[ 入力の作成] をクリックします。
-
ユーザー ID 入力を追加します。
このようにして、アクションは削除するユーザーのユーザー ID を取得します。
表 : 2. 入力 ラベル 名前 タイプ 必須 User ID (ユーザー ID) userID 文字列 要 -
使用している API が要求に対してユーザー認証を必要とする場合は、認証用の入力を追加します。
一般的なユーザー認証入力の例は、アドミンユーザー ID とサイト名です。特定のケースでのユーザー認証の要件については、選択した API のドキュメントを参照してください。API でアクセストークンが必要な場合は、 認証情報の値 変数が後で自動的に作成されるため、入力として追加する必要はありません。
サブフローで完了したアクションを使用する場合は、これらの入力として渡す値を定義します。
-
SOAP ステップまたは REST ステップをアクションアウトラインに追加します。
どちらを選択するかは、統合する SaaS アプリケーションの API によって異なります。
-
[SOAP] を選択した場合は、次のようにフォームに入力します。
表 : 3. SOAP ステップフォーム フィールド Value (値) 接続の詳細 接続 接続エイリアスを使用。 接続エイリアス 統合プロファイルの作成時に作成した接続エイリアス。統合プロファイルをまだ作成していない場合は、手順に従って、 接続エイリアスを使用してカスタム統合プロファイルを作成します。 エンドポイント この値は、接続エイリアスを選択すると自動的に入力されます。これは、エイリアスにリンクされている HTTP(s) 接続レコードからの接続 URL に設定されます。 要求の詳細 エンベロープの作成 手動。 SOAP アクション ユーザーを削除または非アクティブ化する API 要求。選択した API のドキュメントを参照して、適切な要求を選択します。 SOAP エンベロープ ユーザーを削除するための XML 要求メッセージ。XML 要求メッセージを記述する方法については、選択した API のドキュメントを参照してください。一般に、ヘッダーには、ユーザー認証の入力変数と、アクセストークンとしての 認証情報値 変数を含める必要があります。本文には、ユーザーを削除する要求とユーザー ID 入力を含める必要があります。 注:SOAP エンベロープの例については、「 Webex サブスクリプションの再利用」サブフローで使用される「ユーザーを削除」アクションを参照してください。 -
[REST] を選択した場合は、次のようにフォームに入力します。
表 : 4. REST ステップフォーム フィールド Value (値) 接続の詳細 接続 接続エイリアスを使用。 接続エイリアス 統合プロファイルの作成時に作成した接続エイリアス。統合プロファイルをまだ作成していない場合は、手順に従って、 接続エイリアスを使用してカスタム統合プロファイルを作成します。 ベース URL この値は、接続エイリアスを選択すると自動的に入力されます。これは、エイリアスにリンクされている HTTP(s) 接続レコードからの接続 URL に設定されます。 要求の詳細 ビルド要求 手動。 リソースパス リソースへのパス。この値はベース URL に追加されます。リソースパスを構築する方法については、使用している API のドキュメントを参照してください。 HTTP メソッド 削除。 クエリーパラメーター ユーザー ID のパラメーターを追加します。ユーザー ID 入力として値を設定します。 -
エラー処理のために スクリプトステップ をアクションアウトラインに追加します。
- [必須ランタイム] フィールドで [インスタンス] を選択します。
-
入力変数を作成します。
表 : 5. Input Variables (入力変数) 名前 Value (値) 応答 SOAP または REST ステップからの応答本文出力 status_code SOAP または REST ステップからのステータスコード出力 -
出力変数を作成します。
表 : 6. 出力変数 ラベル 名前 タイプ 必須 ステータス ステータス 選択肢 要 error_message error_message 文字列 要 -
[スクリプト] フィールドに、ステータスとエラーメッセージの出力に値を割り当てるスクリプトを記述します。
- status_code入力を使用して、エラーがあるかどうかを確認します。エラーがある場合はステータス出力を [エラー ] に設定し、エラーがない場合は [成功 ] に設定します。
- エラーが発生した場合は、 応答 入力を使用してエラーの種類に関する情報を取得します。エラーメッセージ 出力を エラーの説明に設定して、ユーザーが何が問題だったのかを理解できるようにします。
- [アクションアウトライン] で、[出力] をクリックします。
-
出力変数を作成します。
表 : 7. 出力変数 ラベル 名前 タイプ 必須 ステータス ステータス 選択肢 いいえ エラーメッセージ error_message 文字列 いいえ -
出力変数に値を割り当てます。
表 : 8. 出力変数 ラベル Value (値) ステータス スクリプトステップのステータス出力変数 エラーメッセージ スクリプトステップの出力変数error_message -
アクションをテストするには、[ テスト] をクリックします。
-
テスト結果とシステムログを表示して、エラーの詳細を確認します。
システムログを表示するには、次に移動します: システムログ > システムログ > All (すべて).
- アクションにエラーがある場合は、正しいエンドポイントを使用していること、および API 要求が想定どおりに構造化されていることを確認してください。
注:テストするときは、このアクションによってユーザーが非アクティブ化されることに注意してください。準本番環境でこのアクションをテストします。本番環境のみが利用可能な場合は、テスト用に偽のユーザーを作成できます。 -
テスト結果とシステムログを表示して、エラーの詳細を確認します。
- アクションが期待どおりに機能していることを確認したら、[ 公開] をクリックします。