名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
新しい agentUser オブジェクトを作成します。
POST /users エンドポイントを使用し、要求本文でmicrosoft.graph.agentUserの種類を指定して、エージェント ユーザーを作成することもできます。
少なくとも、必要なプロパティを指定する必要があります。 必要に応じて、その他の書き込み可能なプロパティを指定することもできます。
この操作では、既定では、各 agentUser のプロパティのサブセットのみが返されます。 これらの既定のプロパティは、「プロパティ」セクションに記載されています。 既定で返されないプロパティを取得するには、GET 操作を実行し、$select OData クエリ オプションでプロパティを指定します。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | AgentIdUser.ReadWrite.IdentityParentedBy | AgentIdUser.ReadWrite.All、User.ReadWrite.All |
| 委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
| アプリケーション | AgentIdUser.ReadWrite.IdentityParentedBy | AgentIdUser.ReadWrite.All、User.ReadWrite.All |
重要
AgentIdentity* のアクセス許可は、現在、Microsoft Entra 管理センターの API アクセス許可エクスペリエンスを通じて同意できません。 これらのアクセス許可を使用するには、「プログラムによる API アクセス許可の付与または取り消し」の説明に従って、Microsoft Graph API呼び出しを通じてそれらに同意できます。 これらの アクセス許可の詳細については、「エージェント ID を管理するための アクセス許可」を参照してください。
職場または学校アカウントを使用する委任されたシナリオでは、管理者にサポートされているMicrosoft Entraロールまたはサポートされているロールのアクセス許可を持つカスタム ロールを割り当てる必要があります。 この操作では、次の最小特権ロールがサポートされています。
- エージェント ID 管理者
HTTP 要求
POST /users/microsoft.graph.agentUser
ヒント
また、microsoft.graph.agentUserの種類を指定せずに、POST /users を使用してエージェント ユーザーを作成することもできます。 ただし、 "@odata.type": "microsoft.graph.agentUser" は、ユーザー作成に必要な他のプロパティと共に要求本文で指定する必要があります。
要求ヘッダー
| ヘッダー | 値 |
|---|---|
| Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
| Content-Type | application/json |
要求本文
要求本文で、agentUser オブジェクトの JSON 表現 を指定 します。
次の表に、agentUser を作成するときに必要なプロパティを示します。
| パラメーター | 型 | 説明 |
|---|---|---|
| accountEnabled | Boolean | アカウントが有効な場合は true であり、それ以外の場合は false です。 |
| displayName | 文字列 | エージェント ユーザーのアドレス帳に表示する名前。 |
| mailNickname | 文字列 | エージェント ユーザーのメール エイリアス。 |
| userPrincipalName | String | ユーザー プリンシパル名 (someagent@contoso.com)。 これは、インターネット標準 RFC 822 に基づくエージェント ユーザーのインターネット スタイルのログイン名です。 慣例により、これはエージェント ユーザーの電子メール名にマップされます。 一般的な形式は alias@domain です。このドメインは、検証済みドメインのテナントのコレクション内に存在している必要があります。 テナントの検証済みドメインには、organization の verifiedDomains プロパティからアクセスできます。 注: このプロパティにアクセント文字を含めることはできません。 次の文字のみ使用することができます A - Z、a - z、0 - 9、 ' . - _ ! # ^ ~。 使用できる文字の完全なリストについてはユーザー名 ポリシーを参照してください。 |
| identityParentId | 文字列 | 関連付けられている エージェント ID のオブジェクト ID。 必須です。 |
このリソースは 拡張機能をサポートしているため、 POST 操作を使用し、作成中に独自のデータを含むカスタム プロパティをエージェント ユーザー インスタンスに追加できます。
応答
成功した場合、このメソッドは 201 Created 応答コードと、応答本文の agentUser オブジェクトを返します。
identityParentId が既に別の agentUser にリンクされている agentUser を作成しようとすると、400 Bad Request エラーが返されます。
例
要求
次の例は要求を示しています。
POST https://graph.microsoft.com/beta/users/microsoft.graph.agentUser
Content-type: application/json
{
"accountEnabled": true,
"displayName": "Sales Agent",
"mailNickname": "SalesAgent",
"userPrincipalName": "salesagent@contoso.com",
"identityParentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
応答
次の例は応答を示しています。
ここに示す応答オブジェクトは、読みやすさのために短縮されている可能性があります。
HTTP/1.1 201 Created
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#users/$entity",
"@odata.type": "#microsoft.graph.agentUser",
"id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd",
"businessPhones": [],
"displayName": "Sales Agent",
"mail": "salesagent@contoso.com",
"mailNickname": "SalesAgent",
"userPrincipalName": "salesagent@contoso.com",
"identityParentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}