名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
デジタル ワーカーとして機能する必要がある AI を使用するアプリケーション (エージェント) 用に設計されたMicrosoft Entra IDのユーザー ID の特殊なサブタイプを表します。 エージェント ユーザーは、エージェントがユーザー ID を特に必要とする API とサービスにアクセスし、 idtyp=user 要求でトークンを受け取ります。 エージェント ユーザーは人間の ユーザー とは異なり、所有者、スポンサー、マネージャーなどの関係を通じてのみユーザーにリンクされます。
各エージェント ユーザーは、親エージェント ID との 1 対 1 の関係を維持し、その親の資格情報を介して認証されます。 エージェント ユーザーには、グループへの追加、ライセンスの割り当て、メールボックスやチャットなどの共同作業機能へのアクセスなどのユーザーのような機能があり、パスワード認証、特権管理者ロールの割り当て、ゲスト ユーザーと同様のアクセス許可などのセキュリティ制約の下で動作します。
ユーザーから継承 します。
このリソースは、ここに記載されているプロパティを超える追加のプロパティを許可するオープン型です。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| List | agentUser コレクション | agentUser オブジェクトの一覧を取得します。 |
| Create | agentUser | 新しい agentUser オブジェクトを作成します。 |
| Get | agentUser | agentUser オブジェクトのプロパティとリレーションシップを読み取ります。 |
| Update | agentUser | agentUser オブジェクトを更新します。 |
| Delete | なし | agentUser オブジェクトを削除します。 |
| App role assignments | ||
| アプリの役割の割り当てを一覧表示する | appRoleAssignment コレクション | このエージェント ユーザーのアプリ ロールの割り当てを取得します。 |
| アプリ ロールの割り当てを作成する | appRoleAssignment | このエージェント ユーザーの新しいアプリ ロールの割り当てを作成します。 |
| 削除済みアイテム | ||
| List | directoryObject コレクション | 最近削除されたエージェント ユーザー オブジェクトの一覧を取得します。 |
| Get | directoryObject | 最近削除されたエージェント ユーザーのプロパティを取得します。 |
| 復元 | directoryObject | 最近削除したエージェント ユーザーを復元します。 |
| 完全に削除 | なし | エージェント ユーザーを完全に削除します。 |
| Directory objects | ||
| 所有されているオブジェクトを一覧表示する | directoryObject コレクション | エージェント ユーザーが所有するディレクトリ オブジェクトを取得します。 |
| 組織の関係 | ||
| 直属の部下を一覧表示する | directoryObject コレクション | エージェント ユーザーに報告するユーザーと連絡先を取得します。 |
| List manager | directoryObject | このエージェント ユーザーのマネージャーであるユーザーまたは連絡先を取得します。 |
| マネージャーの追加 | なし | エージェント ユーザーのマネージャーを割り当てます。 |
| Remove manager | なし | エージェント ユーザーのマネージャーを削除します。 |
| 直接メンバーシップを一覧表示する | directoryObject コレクション | エージェント ユーザーがメンバーであるグループ、ディレクトリ ロール、および管理単位を取得します。 |
| 推移的なメンバーシップを一覧表示する | directoryObject コレクション | 入れ子になったグループ メンバーシップなど、エージェント ユーザーがメンバーになっているグループ、ディレクトリ ロール、および管理単位を取得します。 |
| 推移的なレポートを一覧表示する | directoryObject コレクション | エージェント ユーザーの推移的なレポートを取得します。 |
| Sponsors | ||
| List sponsors | directoryObject コレクション | このエージェント ユーザーの特権を担当するユーザーとグループを取得します。 |
| スポンサーを追加する | なし | エージェント ユーザーのスポンサーを追加します。 |
| Remove sponsors | なし | エージェント ユーザーからスポンサーを削除します。 |
プロパティ
重要
このリソースは ユーザーから継承されますが、一部のプロパティは適用されず、 null または既定値が返されます。 これらのプロパティは、次の表から除外されます。
| プロパティ | 型 | 説明 |
|---|---|---|
| accountEnabled | Boolean | アカウントが有効な場合は true であり、それ以外の場合は false です。 このプロパティは、オブジェクトを作成するときに必要です。
ユーザーから継承されます。 |
| assignedLicenses | assignedLicense コレクション | 継承された (グループベースの) ライセンスを含む、エージェント ユーザーに割り当てられたライセンス。 このプロパティは、直接割り当て済みライセンスと継承済みライセンスを区別しません。 licenseAssignmentStates プロパティを使用して、直接割り当て済みライセンスと継承済みライセンスを識別します。 null 許容ではありません。 ユーザーから継承されます。 |
| assignedPlans | assignedPlan collection | エージェント ユーザーに割り当てられているプラン。 読み取り専用です。 null 許容ではありません。 ユーザーから継承されます。 |
| businessPhones | String collection | エージェント ユーザーの電話番号。 このプロパティに設定できる番号は 1 つだけです。 オンプレミス ディレクトリから同期しているユーザーの場合は読み取り専用です。 ユーザーから継承されます。 |
| city | String | エージェント ユーザーが配置されている市区町村。 最大文字数は 128 文字です。 ユーザーから継承されます。 |
| cloudRealtimeCommunicationInfo | cloudRealtimeCommunicationInfo | エージェント ユーザーに関連する Microsoft リアルタイム通信情報。 ユーザーから継承されます。 |
| CompanyName | String | エージェント ユーザーが関連付けられている会社の名前。 このプロパティは、外部ユーザーが所属する会社を記述するのに役立ちます。 最大の長さは 64 文字です。 ユーザーから継承されます。 |
| country | String | エージェント ユーザーが配置されている国またはリージョン。たとえば、 US や UKなどです。 最大文字数は 128 文字です。
ユーザーから継承されます。 |
| createdDateTime | DateTimeOffset | エージェント ユーザーが ISO 8601 形式および UTC で作成された日時。 値は変更できず、エンティティが作成されると自動的に設定されます。 Null 許容型。 オンプレミス ユーザーの場合、値は、Microsoft Entra ID で最初に作成された日時を表します。 2018 年 6 月より前に作成された一部のユーザー、および 2018 年 6 月より前に Microsoft Entra ID に同期されたオンプレミス ユーザーの場合、プロパティは null です。 読み取り専用です。
ユーザーから継承されます。 |
| creationType | String | 読み取り専用です。 Null。 ユーザーから継承されます。 |
| customSecurityAttributes | customSecurityAttributeValue | ディレクトリ オブジェクトに割り当てられたカスタム セキュリティ属性の値を保持するオープン複合型。 Null 許容型。 ユーザーから継承されます。 |
| deletedDateTime | DateTimeOffset | ユーザーが削除された日付と時刻。 directoryObject から継承されます。 |
| department | String | ユーザーが働いている部署の名前。 最大文字数は 64 文字です。 ユーザーから継承されます。 |
| displayName | String | アドレス帳に表示されるユーザーの名前。 この値は通常、ユーザーの名前、ミドルネームのイニシャル、姓の組み合わせになります。 このプロパティはユーザーの作成時に必須です。更新時にクリアすることはできません。 最大文字数は 256 文字です。 ユーザーから継承されます。 |
| employeeHireDate | DateTimeOffset | ユーザーが採用された日時、または将来採用される場合に仕事を開始する予定の日時。 ユーザーから継承されます。 |
| employeeId | String | 組織によりユーザーに割り当てられた従業員 ID。 最大長は 16 文字です。 ユーザーから継承されます。 |
| employeeLeaveDateTime | DateTimeOffset | ユーザーが退職した日時または退職する予定の日時。 このプロパティを読み取るには、呼び出し元のアプリに User-LifeCycleInfo.Read.All アクセス許可を割り当てる必要があります。 このプロパティを書き込むには、呼び出し元のアプリに User.Read.All および User-LifeCycleInfo.ReadWrite.All アクセス許可を割り当てる必要があります。 代理シナリオでこのプロパティを読み取るには、管理者に Lifecycle Workflows Administrator (ライフサイクル ワークフロー管理者) か、Global Reader (グローバル閲覧者) の、どちらかの Microsoft Entra ロールが必要です。 代理シナリオでこのプロパティを書き込むには、管理者にグローバル管理者役割が必要です。 詳細については、「ユーザーの employeeLeaveDateTime プロパティを構成する」を参照してください。 ユーザーから継承されます。 |
| employeeOrgData | employeeOrgData | ユーザーに関連付けられている組織データ (部署や costCenter など) を表します。 ユーザーから継承されます。 |
| employeeType | String | エンタープライズ ワーカーの種類を取得します。 たとえば、Employee、Contractor、Consultant、または Vendor です。
ユーザーから継承されます。 |
| faxNumber | String | ユーザーの Fax 番号。 ユーザーから継承されます。 |
| givenName | String | ユーザーの名。 最大文字数は 64 文字です。 ユーザーから継承されます。 |
| id | String | ユーザーの一意の識別子。 不透明な識別子として扱う必要があります。 directoryObject から継承されます。 null 許容ではありません。 読み取り専用です。 エンティティから継承します |
| identityParentId | 文字列 | 関連付けられている エージェント ID のオブジェクト ID を参照します。 このプロパティは、オブジェクトを作成するときに必要であり、更新中にクリアすることはできません。 ユーザーから継承されます。 |
| imAddresses | String collection | ユーザーのインスタント メッセージ ボイス オーバー IP (VOIP) セッション開始プロトコル (SIP) のアドレス。 読み取り専用です。 ユーザーから継承されます。 |
| infoCatalogs | String コレクション | ユーザーに割り当てられている情報セグメントを示します。 ユーザーから継承されます。 |
| isLicenseReconciliationNeeded | ブール型 | ユーザーが Exchange メールボックス ライセンスの割り当てを保留しているかどうかを示します。 読み取り専用です。 ユーザーから継承されます。 |
| isManagementRestricted | ブール型 |
true ユーザーが制限付き管理管理単位のメンバーである場合。 設定されていない場合、既定値は null 、既定の動作は false です。 読み取り専用です。 制限付き管理管理単位のメンバーであるユーザーを管理するには、管理者または呼び出し元アプリに、制限付き管理管理単位のスコープでMicrosoft Entraロールを割り当てる必要があります。
ユーザーから継承されます。 |
| isResourceAccount | ブール値 | 使わないでください。今後の使用のために予約されています。 ユーザーから継承されます。 |
| jobTitle | String | ユーザーの役職。 最大文字数は 128 文字です。 ユーザーから継承されます。 |
| licenseAssignmentStates | licenseAssignmentState コレクション | このユーザーへのライセンス割り当ての状態です。 また、直接割り当てられたライセンス、およびユーザーがグループ メンバーシップを通じて継承したライセンスも示します。 読み取り専用です。 ユーザーから継承されます。 |
| String | ユーザーの SMTP アドレス (たとえば、admin@contoso.com)。 このプロパティを変更すると、その値が SMTP アドレスとして表示されるように、ユーザーの proxyAddresses コレクションも更新されます。 このプロパティにアクセント記号は使用できません。 メモ: Azure AD B2C ユーザー プロファイル用にこのプロパティを更新することはお勧めしません。 代わりに otherMails プロパティを使用してください。
ユーザーから継承されます。 |
|
| mailNickname | String | ユーザーの電子メール エイリアス。 ユーザーの作成時に、このプロパティを指定する必要があります。 最大文字数は 64 文字です。 ユーザーから継承されます。 |
| mobilePhone | String | ユーザーの主な携帯電話の番号。 オンプレミス ディレクトリから同期しているユーザーについては読み取り専用になります。 ユーザーから継承されます。 |
| officeLocation | String | ユーザーの勤務先の場所。 最大文字数は 128 文字です。 ユーザーから継承されます。 |
| otherMails | String collection | ユーザーの追加のメール アドレスの一覧 (例: ["bob@contoso.com", "Robert@fabrikam.com"])。 それぞれ 250 文字に制限された値を、最大で 250 個まで格納できます。 注意: このプロパティにアクセント文字を含めることはできません。
ユーザーから継承されます。 |
| postalCode | String | ユーザーの住所の郵便番号。 郵便番号は、ユーザーの国/地域に固有です。 アメリカ合衆国では、この属性には、ZIP コードが含まれます。 最大文字数は 40 文字です。 ユーザーから継承されます。 |
| preferredDataLocation | String | ユーザーの優先されるデータの場所。 詳細については、「OneDrive Online Multi-Geo」を参照してください。 ユーザーから継承されます。 |
| preferredLanguage | String | ユーザーが設定する言語。 既定の言語形式は RFC 4646 に基づいています。 名前は、言語に関する ISO 639 の 2 文字のカルチャ コード (小文字) と、国や地域に関する ISO 3166 の 2 文字のサブカルチャ コード (大文字) の組み合わせです。 たとえば、"en-US" や "es-ES" です。 ユーザーから継承されます。 |
| provisionedPlans | ProvisionedPlan コレクション | ユーザーのために用意されたプラン。 読み取り専用です。 null 許容ではありません。 ユーザーから継承されます。 |
| proxyAddresses | String collection | 例: ["SMTP: bob@contoso.com", "smtp: bob@sales.contoso.com"]。
mail プロパティを変更すると、その値が SMTP アドレスとして表示されるように、このコレクションも更新されます。 詳細については、「mail および proxyAddresses プロパティ」を参照してください。 先頭に SMTP (大文字) が付くプロキシ アドレスがプライマリ プロキシ アドレスで、先頭に smtp が付くプロキシ アドレスはセカンダリ プロキシ アドレスです。 Azure AD B2C アカウントの場合、このプロパティには一意のアドレスが 10 個までの制限があります。 Microsoft Graph では読み取り専用です。このプロパティは、Microsoft 365 管理センターからのみ更新できます。 null 許容ではありません。
ユーザーから継承されます。 |
| refreshTokensValidFromDateTime | DateTimeOffset | この時点よりも前に発行された更新トークンとセッション トークン (セッション Cookie) はすべて無効であり、アプリケーションが無効な更新トークンまたはセッション トークンを使用して (Microsoft Graph などの API にアクセスする目的で) 代理アクセス トークンを取得しようとすると、エラーが発生します。 この状況が発生した、アプリケーションは承認されたエンドポイントを要求して、新しい更新トークンを取得する必要があります。 読み取り専用です。 リセットするには invalidateAllRefreshTokens を使用します。 ユーザーから継承されます。 |
| securityIdentifier | 文字列 | Windows シナリオで使用されるユーザーのセキュリティ識別子 (SID)。 読み取り専用です。 既定で返されます。 ユーザーから継承されます。 |
| showInAddressList | Boolean | Microsoft Graph では使用しないでください。 Microsoft 365 管理センターを通じてこのプロパティを管理してください。 エージェント ユーザーを Outlook グローバル アドレス一覧に含める必要があるかどうかを表します。 「既知の問題」を参照してください。 ユーザーから継承されます。 |
| signInSessionsValidFromDateTime | DateTimeOffset | この時点よりも前に発行された更新トークンとセッション トークン (セッション Cookie) はすべて無効であり、アプリケーションが無効な更新トークンまたはセッション トークンを使用して (Microsoft Graph などの API にアクセスする目的で) 代理アクセス トークンを取得しようとすると、エラーが発生します。 この状況が発生した場合、アプリケーションは承認されたエンドポイントを要求して、新しい更新トークンを取得する必要があります。 読み取り専用です。 revokeSignInSessions を使用して再設定します。 ユーザーから継承されます。 |
| state | String | エージェント ユーザーのアドレス内の状態または都道府県。 最大文字数は 128 文字です。 ユーザーから継承されます。 |
| streetAddress | String | エージェント ユーザーの勤務先の番地。 最大文字数は 1024 文字です。 ユーザーから継承されます。 |
| surname | String | ユーザーの姓。 最大文字数は 64 文字です。 ユーザーから継承されます。 |
| usageLocation | String | 2 文字の国コード (ISO 規格 3166) 国のサービスの可用性をチェックするための法的要件のためにライセンスが割り当てられているエージェント ユーザーに必要です。 たとえば、US、JP、GB などがあります。 null 許容ではありません。
ユーザーから継承されます。 |
| userPrincipalName | String | エージェント ユーザーのユーザー プリンシパル名 (UPN)。 UPN は、インターネット標準 RFC 822 に基づいた、インターネット スタイルのユーザーのサインイン名です。 慣例により、これはエージェント ユーザーの電子メール名にマップされます。 一般的な形式は alias@domain です。このドメインは、テナントの検証済みドメインのコレクション内に存在している必要があります。 このプロパティは、ユーザーの作成時に必要です。 テナントの検証済みドメインには、organization の verifiedDomains プロパティからアクセスできます。 このプロパティにアクセント文字を含めることはできません。 次の文字のみ使用することができます A - Z、a - z、0 - 9、' . - _ ! # ^ ~。 使用できる文字の完全なリストについてはユーザー名 ポリシーを参照してください。
ユーザーから継承されます。 |
| userType | String | ディレクトリ内のエージェント ユーザーの種類を分類するために使用できる文字列型 (String) の値。 有効な値は Member および Guest です。
手記:メンバーおよびゲスト ユーザーのアクセス許可の詳細については、「Microsoft Entra IDの既定のユーザーアクセス許可とは」を参照してください。ユーザーから継承されます。 |
リレーションシップ
重要
このリソースの種類は ユーザー リソースの種類からすべてのリレーションシップを継承しますが、一部のリレーションシップはエージェント ユーザーには適用されず、常に null または既定値を返します。 これらのリレーションシップは、わかりやすくするために、次の表から除外されます。
| リレーションシップ | 型 | 説明 |
|---|---|---|
| appRoleAssignments | appRoleAssignment コレクション | エージェント ユーザーがアプリケーションに対して付与したアプリ ロールを表します。 ユーザーから継承 |
| directReports | directoryObject コレクション | エージェント ユーザーに報告するユーザーと連絡先。 (マネージャー プロパティがこのユーザーに設定されている、ユーザーと連絡先。) 読み取り専用です。 Null 許容型。 ユーザーから継承 |
| manager | directoryObject | このエージェント ユーザーのマネージャーであるユーザーまたは連絡先。 読み取り専用です。 ユーザーから継承 |
| memberOf | directoryObject コレクション | エージェント ユーザーがメンバーであるグループ、ディレクトリ ロール、および管理単位。 読み取り専用です。 Null 許容型。 ユーザーから継承 |
| ownedObjects | directoryObject コレクション | エージェント ユーザーが所有するディレクトリ オブジェクト。 読み取り専用です。 Null 許容型。 ユーザーから継承 |
| スポンサー | directoryObject コレクション | テナント内のこのエージェント ユーザーの特権を担当する ユーザー と グループ は、エージェント ユーザーの情報とアクセスを更新したままにします。 (HTTP メソッド: GET、POST、DELETE)。 ユーザーから継承 |
| transitiveMemberOf | directoryObject コレクション | エージェント ユーザーがメンバーである入れ子になったグループとディレクトリ ロールを含むグループ。 Null 許容型。 ユーザーから継承 |
| transitiveReports | directoryObject コレクション | エージェント ユーザーの推移的なレポート。 読み取り専用です。 ユーザーから継承 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"@odata.type": "#microsoft.graph.agentUser",
"id": "String (identifier)",
"deletedDateTime": "String (timestamp)",
"accountEnabled": "Boolean",
"assignedLicenses": [
{
"@odata.type": "microsoft.graph.assignedLicense"
}
],
"assignedPlans": [
{
"@odata.type": "microsoft.graph.assignedPlan"
}
],
"businessPhones": [
"String"
],
"city": "String",
"cloudRealtimeCommunicationInfo": {
"@odata.type": "microsoft.graph.cloudRealtimeCommunicationInfo"
},
"companyName": "String",
"country": "String",
"countryCode": "Integer",
"createdDateTime": "String (timestamp)",
"creationType": "String",
"customSecurityAttributes": {
"@odata.type": "microsoft.graph.customSecurityAttributeValue"
},
"department": "String",
"displayName": "String",
"employeeHireDate": "String (timestamp)",
"employeeId": "String",
"employeeOrgData": {
"@odata.type": "microsoft.graph.employeeOrgData"
},
"employeeType": "String",
"employeeLeaveDateTime": "String (timestamp)",
"faxNumber": "String",
"givenName": "String",
"imAddresses": [
"String"
],
"infoCatalogs": [
"String"
],
"isLicenseReconciliationNeeded": "Boolean",
"isManagementRestricted": "Boolean",
"isResourceAccount": "Boolean",
"jobTitle": "String",
"licenseAssignmentStates": [
{
"@odata.type": "microsoft.graph.licenseAssignmentState"
}
],
"mail": "String",
"mailNickname": "String",
"mobilePhone": "String",
"otherMails": [
"String"
],
"officeLocation": "String",
"postalCode": "String",
"preferredDataLocation": "String",
"preferredLanguage": "String",
"provisionedPlans": [
{
"@odata.type": "microsoft.graph.provisionedPlan"
}
],
"proxyAddresses": [
"String"
],
"refreshTokensValidFromDateTime": "String (timestamp)",
"securityIdentifier": "String",
"showInAddressList": "Boolean",
"signInSessionsValidFromDateTime": "String (timestamp)",
"state": "String",
"streetAddress": "String",
"surname": "String",
"usageLocation": "String",
"userPrincipalName": "String",
"userType": "String",
"identityParentId": "String"
}