属性の追加 (ユーザー フローへ)

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

externalUsersSelfServiceSignupEventsFlow オブジェクトで表される外部 ID セルフサービス サインアップ ユーザー フローに属性を追加します。 カスタム属性と組み込み属性の両方をユーザー フローに追加できます。

属性は、ユーザー・フローで attributeCollection>attributes コレクションと attributeCollection>attributeCollectionPage>views コレクションの両方に追加されます。 views コレクションでは、属性にはデフォルト設定が割り当てられます。 ユーザー フローにパッチを適用して、ビュー オブジェクトの属性の設定をカスタマイズできます。たとえば、必須としてマークしたり、許可された入力型を更新したりできます。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ❌ ❌ ✅

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) EventListener.ReadWrite.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション EventListener.ReadWrite.All 注意事項なし。

重要

職場または学校アカウントを使用して委任されたアクセスの場合、サインインしたユーザーはグループの所有者またはメンバーであるか、サポートされている Microsoft Entra ロール、またはこの操作に必要なアクセス許可を付与するカスタム ロールが割り当てられている必要があります。 外部 ID ユーザー フロー管理者は、この操作でサポートされる最小特権ロールです。

HTTP 要求

POST /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/$ref

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. 必須です。

要求本文

リクエスト本文で、ユーザーフローに追加する identityUserFlowAttribute オブジェクトの ID を持つ odata.id プロパティを指定します。

応答

成功した場合、このメソッドは 204 No Content 応答コードを返します。 失敗した場合、4xx エラーが詳細情報とともに返されます。

例

要求

次の例は、外部 ID のセルフサービス サインアップ ユーザー フローの属性収集ステップの属性として市を追加する要求を示しています。 要求が成功すると、属性はユーザー・フローの attributeCollection>attributes コレクションと attributeCollection>attributeCollectionPage>views コレクションの両方に追加されます。 ユーザーフローに属性を追加した後、 ユーザーフローにパッチを適用 して、 ビュー オブジェクトの属性の設定をカスタマイズする (ページレイアウトをカスタマイズする) ことができます。

POST https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/$ref

{
    "@odata.id":"https://graph.microsoft.com/beta/identity/userFlowAttributes/city"
} 

応答

次の例は応答を示しています。

HTTP/1.1 204 No Content