(ユーザー フローの) 属性を一覧表示する

  • [アーティクル]

名前空間: microsoft.graph

externalUsersSelfServiceSignupEventsFlow オブジェクトによって表される外部 ID セルフサービス ユーザー フローに関連付けられている identityUserFlowAttribute コレクションを取得します。 これらの属性は、ユーザー フローによって定義された認証エクスペリエンス中にユーザーから収集されます。

アクセス許可

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

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

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

HTTP 要求

GET /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/

オプションのクエリ パラメーター

このメソッドは、 $filter、 $expand、 $orderby OData クエリ パラメーターをサポートし、応答のカスタマイズに役立ちます。 一般的な情報については、「OData クエリ パラメーター」を参照してください。

要求ヘッダー

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

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文に新しい identityUserFlowAttribute オブジェクトを返します。

ユーザー フロー属性がユーザー フローに割り当てられていない場合、このメソッドは 400 Bad Request エラー コードを返します。

例

要求

次の例は、ユーザー フローに関連付けられている属性を取得する要求を示しています。

GET https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/

応答

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

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.identityUserFlowAttribute)",
    "value": [
        {
            "id": "email",
            "displayName": "Email Address",
            "description": "Email address of the user",
            "userFlowAttributeType": "builtIn",
            "dataType": "string"
        },
        {
            "id": "displayName",
            "displayName": "Display Name",
            "description": "Display Name of the User.",
            "userFlowAttributeType": "builtIn",
            "dataType": "string"
        },
        {
            "id": "extension_6ea3bc85aec24b1c92ff4a117afb6621_Favoritecolor",
            "displayName": "Favorite color",
            "description": "what is your favorite color",
            "userFlowAttributeType": "custom",
            "dataType": "string"
        }
    ]
}