PATCH
呼び出しを行います。
-
/patch_connections_by_id
エンドポイントにアクセスするための有効なアクセストークンを取得します。トークンには、update:connections
スコープが含まれている必要があります。詳細については、[Management API Access Tokens(Management APIのアクセストークン)]を参照してください。 -
アクセストークンと拒否する属性のリストを使用して、API を呼び出します。以下は、ethnicityとgenderの2つの属性を拒否するHTTP要求の例です。1つまたは2つの値のみを更新する場合は「マージ」が行われないため、optionsオブジェクトを取得してPATCH要求でオブジェクト全体を送信する必要があることに注意してください。
ここでは、
-
{yourConnectionId}
は、これらの属性が拒否される接続 IDです。 -
{yourToken}
は、前の手順で受け取ったアクセストークンです。 -
options.non_persistent_attrs
オブジェクトは、拒否される属性の配列を保持します。拒否するクレームがアップストリームのIDプロバイダー(IdP)によって送信されている場合は、アップストリームのIdPによって送信されたとおりにクレームを設定する必要があります。たとえば、https://acme.com/temporary_idtoken
として受信されたクレームの場合、上記のサンプルのnon_persistent_attrs
オブジェクトオブジェクトが読み取ります。
-
制限事項
-
拒否できるのは、ルート フィールド(
user.name
やuser.phone_number
など)のみです。user.name
またはuser.nickname
が拒否された場合、それらはトークンに含まれません。user.email
が拒否された場合、その値はカスタムクレームにマッピングできません。たとえば、ルールでは、context.idトークン[namespace + 'work_email'] = user.email
は機能しません。
-
属性を拒否しても、ルールと送信トークンを介して使用できます。ただし、次のいずれかに該当する場合、拒否リスト属性はトークンに含まれません :
- 多要素認証(MFA)を有効にしています
- ルールを介してリダイレクトを実行しています
- アプリで委任を使用しています(かつ、
scope = passthrough
を設定していない) - アプリはなりすましを使用しています
- [Use Auth0 instead of the IdP to do Single Sign-On(IdPの代わりにAuth0を使用してシングルサインオン)] の設定を有効にしています(レガシーテナントのみ)
- SAMLP接続の場合、デバッグモードを有効にすると、ログに拒否リスト属性に関する情報が含まれます
user.app_metadata
オブジェクトに保持することができます。