authenticationEventsFlow を更新する
名前空間: microsoft.graph
authenticationEventsFlow オブジェクトのプロパティを ID で更新します。 更新するには、@odata.type プロパティと authenticationEventsFlow オブジェクトの種類の値を指定する必要があります。 次の派生サブタイプがサポートされています。
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | EventListener.ReadWrite.All | 注意事項なし。 |
| 委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
| アプリケーション | EventListener.ReadWrite.All | 注意事項なし。 |
委任されたシナリオの場合、管理者には少なくとも外部 ID ユーザー フロー管理者Microsoft Entraロールが必要です。
HTTP 要求
PATCH /identity/authenticationEventsFlows/{authenticationEventsFlow-id}
要求ヘッダー
| 名前 | 説明 |
|---|---|
| Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
| Content-Type | application/json. 必須です。 |
要求本文
要求本文で、更新すべきプロパティの値のみを指定します。 要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。
次の表に、更新できるプロパティを示します。
@odata.type プロパティは、本文に特定のユーザー フローの種類の値を含める必要があります。 たとえば、「 "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignupEventsFlow" 」のように入力します。
| プロパティ | 種類 | 説明 |
|---|---|---|
| id | String | エンティティの一意識別子。 読み取り専用。 |
| displayName | String | イベント ポリシーの表示名。 |
| 説明 | String | イベント ポリシーの説明。 |
| conditions | authenticationConditions | イベント ポリシーが呼び出されるかどうかを判断するために使用される認証要求のコンテキストを表す条件。 |
応答
成功した場合、このメソッドは 204 No Content 応答コードを返します。 失敗した場合は、特定の 4xx 詳細を含むエラーが返されます。
例
例 1: 外部 ID セルフサービス サインアップ ユーザー フローの表示名を更新する
要求
次の例は、特定の外部 ID ユーザー フローの表示名を更新する要求を示しています。
PATCH https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",
"displayName": "New user flow description",
}
応答
次の例は応答を示しています。
HTTP/1.1 204 No Content
例 2: 外部 ID セルフサービス サインアップ ユーザー フローの onAttributeCollection イベントを更新する
セルフサービス サインアップ ユーザー フローの属性収集ステップ中に収集する属性として city (組み込み属性) を追加します。 入力オブジェクトで、保持するすべての属性を指定する必要があります。それ以外の場合は、ユーザー フローから削除されます。
要求
PATCH https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",
"onAttributeCollection": {
"@odata.type": "#microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp",
"attributeCollectionPage": {
"views": [
{
"title": null,
"description": null,
"inputs": [
{
"attribute": "email",
"label": "Email Address",
"inputType": "text",
"defaultValue": null,
"hidden": true,
"editable": false,
"writeToDirectory": true,
"required": true,
"validationRegEx": "^[a-zA-Z0-9.!#$%&’'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:.[a-zA-Z0-9-]+)*$",
"options": []
},
{
"attribute": "displayName",
"label": "Display Name",
"inputType": "text",
"defaultValue": null,
"hidden": false,
"editable": true,
"writeToDirectory": true,
"required": false,
"validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$",
"options": []
},
{
"attribute": "city",
"label": "City",
"inputType": "text",
"defaultValue": null,
"hidden": false,
"editable": true,
"writeToDirectory": true,
"required": false,
"validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$",
"options": []
},
{
"attribute": "extension_6ea3bc85aec24b1c92ff4a117afb6621_Favoritecolor",
"label": "Favorite color",
"inputType": "text",
"defaultValue": null,
"hidden": false,
"editable": true,
"writeToDirectory": true,
"required": false,
"validationRegEx": "^.*",
"options": []
}
]
}
]
}
}
}
応答
次の例は応答を示しています。
HTTP/1.1 204 No Content
例 3: 外部 ID セルフサービス サインアップ ユーザー フロー中に収集された属性を削除する
セルフサービス サインアップ ユーザー フローの属性収集ステップ中に収集する属性として city を削除します。 要求本文から city 属性を除外すると、属性はユーザー フローから削除されます。
要求
PATCH https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",
"onAttributeCollection": {
"@odata.type": "#microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp",
"attributeCollectionPage": {
"views": [
{
"title": null,
"description": null,
"inputs": [
{
"attribute": "email",
"label": "Email Address",
"inputType": "text",
"defaultValue": null,
"hidden": true,
"editable": false,
"writeToDirectory": true,
"required": true,
"validationRegEx": "^[a-zA-Z0-9.!#$%&’'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:.[a-zA-Z0-9-]+)*$",
"options": []
},
{
"attribute": "displayName",
"label": "Display Name",
"inputType": "text",
"defaultValue": null,
"hidden": false,
"editable": true,
"writeToDirectory": true,
"required": false,
"validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$",
"options": []
},
{
"attribute": "extension_6ea3bc85aec24b1c92ff4a117afb6621_Favoritecolor",
"label": "Favorite color",
"inputType": "text",
"defaultValue": null,
"hidden": false,
"editable": true,
"writeToDirectory": true,
"required": false,
"validationRegEx": "^.*",
"options": []
}
]
}
]
}
}
}
応答
次の例は応答を示しています。
HTTP/1.1 204 No Content
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示