identityUserFlowAttribute の作成

名前空間: microsoft.graph

重要

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

新しいカスタム identityUserFlowAttribute オブジェクトを作成します。

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

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

アクセス許可

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

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

重要

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

HTTP 要求

POST /identity/userFlowAttributes

要求ヘッダー

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

要求本文

要求本文で、 identityUserFlowAttribute の JSON 表現を指定します。

プロパティ 型 説明
id String ユーザー フロー属性の ID。 これは読み取り専用属性であり、自動的に作成されます。
displayName String ユーザー フロー属性の表示名。
説明 String ユーザー フロー属性の説明。 サインアップ時にユーザーに表示されます。
userFlowAttributeType String ユーザー フロー属性の種類。 これは読み取り専用属性であり、自動的に設定されます。 属性の型に応じて、このプロパティの値は builtIn または custom になります。
dataType String ユーザー フロー属性のデータ型。 カスタム ユーザー フロー属性が作成されると、これを変更することはできません。 dataType でサポートされる値は次のとおりです。
  • string : identityUserFlowAttribute の dataType が文字列であることを示します。
  • Boolean : identityUserFlowAttribute の dataType がブール値であることを示します。
  • int64 : identityUserFlowAttribute の dataType が整数であることを示します。

応答

成功した場合、このメソッドは応答本文で 201 Created 応答コードと identityUserFlowAttribute オブジェクトを返します。 失敗した場合は、具体的な詳細を含む 4xx エラーが返されます。

例

要求

次の例は要求を示しています。

POST https://graph.microsoft.com/beta/identity/userFlowAttributes
Content-type: application/json

{
  "displayName": "Hobby",
  "description": "Your hobby",
  "dataType": "string"
}

応答

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

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 201 Created
Location: "/identity/userFlowAttributes('extension_d09380e2b4c642b9a203fb816a04a7ad_Hobby')"
Content-type: application/json

{
    "id": "extension_d09380e2b4c642b9a203fb816a04a7ad_Hobby",
    "displayName": "Hobby",
    "description": "Your hobby",
    "userFlowAttributeType": "custom",
    "dataType": "string"
}