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