リスト b2xIdentityUserFlowsList b2xIdentityUserFlows

名前空間: microsoft.graphNamespace: microsoft.graph

重要

/betaMicrosoft Graph のバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。Use of these APIs in production applications is not supported. API が v2.0 で利用できるかどうかを確認するには、 バージョン セレクターを使用します。To determine whether an API is available in v1.0, use the Version selector.

B2xIdentityUserFlowオブジェクトのリストを取得します。Retrieve a list of b2xIdentityUserFlow objects.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) インスタンスフローすべて。すべてのインスタンスを取得します。IdentityUserFlow.Read.All, IdentityUserFlow.ReadWrite.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication インスタンスフローすべて。すべてのインスタンスを取得します。IdentityUserFlow.Read.All, IdentityUserFlow.ReadWrite.All

職場または学校のアカウントは、次の役割のいずれかに属している必要があります。The work or school account needs to belong to one of the following roles:

  • 全体管理者Global administrator
  • 外部 Id ユーザーフロー管理者External Identity User Flow administrator

HTTP 要求HTTP request

GET /identity/b2xUserFlows

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

を使用し $expand て、既定で展開されていない特定のユーザーフロープロパティを展開できます。You can use $expand to expand specific user flow properties that are not expanded by default.

詳細については、「OData クエリ パラメーター」を参照してください。For more information, see OData query parameters.

要求ヘッダーRequest headers

名前Name 説明Description
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.

要求本文Request body

このメソッドには、要求本文を指定しません。Do not supply a request body for this method.

応答Response

成功した場合、このメソッドは応答 200 OK コードと、応答本文で b2xIdentityUserFlow オブジェクトのコレクションを返します。If successful, this method returns a 200 OK response code and a collection of b2xIdentityUserFlow objects in the response body.

Examples

例 1: すべての b2xIdentityUserFlow オブジェクトを一覧表示するExample 1: List all b2xIdentityUserFlow objects

要求Request

要求の例を次に示します。The following is an example of the request.

GET https://graph.microsoft.com/beta/identity/b2xUserFlows

応答Response

応答の例を次に示します。The following is an example of the response.

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。Note: The response object shown here might be shortened for readability.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/b2xUserFlows",
    "value": [
      {
          "id": "B2X_1_PartnerSignUp",
          "userFlowType": "signUpOrSignIn",
          "userFlowTypeVersion": 1
      },
      {
          "id": "B2X_1_ContosoSignUp",
          "userFlowType": "signUpOrSignIn",
          "userFlowTypeVersion": 1
      },
    ]
}

例 2: すべての b2xIdentityUserFlow オブジェクトを一覧表示し、プロバイダーを展開するExample 2: List all b2xIdentityUserFlow objects and expand identityProviders

要求Request

要求の例を次に示します。The following is an example of the request.

GET https://graph.microsoft.com/beta/identity/b2xUserFlows?$expand=identityProviders

応答Response

応答の例を次に示します。The following is an example of the response.

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。Note: The response object shown here might be shortened for readability.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/b2xUserFlows(identityProviders)",
    "value": [
      {
          "id": "B2X_1_PartnerSignUp",
          "userFlowType": "signUpOrSignIn",
          "userFlowTypeVersion": 1,
          "identityProviders": [
              {
                "id": "Facebook-OAuth",
                "type": "Facebook",
                "name": "Facebook",
                "clientId": "clientIdFromFacebook",
                "clientSecret": "*******"
              }  
          ]
      },
      {
          "id": "B2X_1_ContosoSignUp",
          "userFlowType": "signUpOrSignIn",
          "userFlowTypeVersion": 1,
          "identityProviders": [
              {
                "id": "Facebook-OAuth",
                "type": "Facebook",
                "name": "Facebook",
                "clientId": "clientIdFromFacebook",
                "clientSecret": "*******"
              }  
          ]
      }
   ]
}