エージェント ユーザーの作成

名前空間: microsoft.graph

新しい agentUser オブジェクトを作成します。 また、POST /users エンドポイントを使用し、要求本文でmicrosoft.graph.agentUserの種類を指定することで、エージェント ユーザーを作成することもできます。

少なくとも、必須プロパティを指定する必要があります。 必要に応じて、その他の書き込み可能なプロパティを指定することもできます。

この操作は、デフォルトで各 agentUser のプロパティのサブセットのみを返します。 これらの既定のプロパティは、「プロパティ」セクションに記載されています。 既定で返されないプロパティを取得するには、GET 操作を実行し、$select OData クエリ オプションでプロパティを指定します。

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

アクセス許可

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

HTTP 要求

POST /users/microsoft.graph.agentUser

要求ヘッダー

要求本文

リクエスト本文には、 agentUser オブジェクトの JSON 表現を指定します。

次の表に、agentUser の作成時に必要なプロパティを示します。

このリソースは 拡張機能をサポートしているため、 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"
}

const options = {
	authProvider,
};

const client = Client.init(options);

const agentUser = {
  accountEnabled: true,
  displayName: 'Sales Agent',
  mailNickname: 'SalesAgent',
  userPrincipalName: 'salesagent@contoso.com',
  identityParentId: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'
};

await client.api('/users/microsoft.graph.agentUser')
	.version('beta')
	.post(agentUser);

応答

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

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

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"
}

関連コンテンツ

• 拡張機能を使用してカスタム データをリソースに追加する
• オープン拡張機能を使用してカスタム データをユーザーに追加する