agentUser を更新する

名前空間: microsoft.graph

agentUser オブジェクトのプロパティを更新します。

アクセス許可

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

特定のシナリオのアクセス許可

• 個人用 Microsoft アカウントに対する User.ReadWrite 委任されたアクセス許可を使用してプロファイルを更新するには、個人用の Microsoft アカウントを Microsoft Entra テナントに関連付ける必要があります。
• employeeLeaveDateTime プロパティを更新するには、次の手順を実行します。
  • 委任されたシナリオでは、管理者には グローバル管理者 ロールが必要です。アプリには、 User.Read.All および User-LifeCycleInfo.ReadWrite.All の委任されたアクセス許可を付与する必要があります。
  • Microsoft Graph のアクセス許可を持つアプリのみのシナリオでは、アプリに User.Read.All および User-LifeCycleInfo.ReadWrite.All のアクセス許可を付与する必要があります。
• customSecurityAttributes プロパティを更新するには:
  • 委任されたシナリオでは、管理者に 属性割り当て管理者 ロールを割り当て、アプリに CustomSecAttributeAssignment.ReadWrite.All アクセス許可を付与する必要があります。
  • Microsoft Graph のアクセス許可を持つアプリのみのシナリオでは、アプリに CustomSecAttributeAssignment.ReadWrite.All アクセス許可を付与する必要があります。
• User-Mail.ReadWrite.All は、 otherMails プロパティを更新するための最低特権のアクセス許可です。
• User-PasswordProfile.ReadWrite.All は、 passwordProfile プロパティを更新するための最低特権アクセス許可です。
• User-Phone.ReadWrite.All は、 businessPhones プロパティと mobilePhone プロパティを更新するための最低特権のアクセス許可です。
• User.EnableDisableAccount.All + User.Read.All は、 accountEnabled プロパティを更新するためのアクセス許可の最小特権の組み合わせです。
• id プロパティを更新するには、User.ManageIdentities.Allが必要です。

HTTP 要求

PATCH /users/microsoft.graph.agentUser/{userId}

要求ヘッダー

要求本文

リクエストの本文には、更新するプロパティの値 のみ を指定します。 要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。

次の表に、更新できるプロパティを示します。

agentUser を更新するときは、リクエスト本文で @odata.type を #microsoft.graph.agentUser として指定する必要があります。

agentUser リソースは拡張機能をサポートしているため、PATCH操作を使用して、既存の agentUser インスタンスの拡張機能のカスタム プロパティで独自のアプリ固有のデータを追加、更新、または削除できます。

拡張機能と関連データを管理する

この API を使用して、エージェント ユーザーのディレクトリ、スキーマ、オープン拡張機能とそのデータを次のように管理します。

• 既存のエージェント ユーザーの拡張機能にデータを追加、更新、保存します
• ディレクトリおよびスキーマ拡張機能の場合は、カスタム拡張プロパティの値を null に設定して、格納されているデータをすべて削除します。 オープン拡張機能の場合は、［オープン拡張機能を削除する］ API を使用します。

応答

成功した場合、このメソッドは応答本文で 200 OK 応答コードと更新された agentUser オブジェクトを返します。

例

要求

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

PATCH https://graph.microsoft.com/beta/users/microsoft.graph.agentUser/{userId}
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.agentUser",
  "accountEnabled": true,
  "assignedLicenses": [
    {
      "@odata.type": "microsoft.graph.assignedLicense"
    }
  ],
  "businessPhones": [
    "+1 425 555 0109"
  ],
  "city": "Seattle",
  "companyName": "Contoso",
  "country": "United States",
  "department": "Sales",
  "displayName": "Sales Agent",
  "employeeId": "12345",
  "employeeType": "Agent",
  "givenName": "Sales",
  "employeeHireDate": "2024-01-15T00:00:00Z",
  "employeeLeaveDateTime": null,
  "employeeOrgData": {
    "@odata.type": "microsoft.graph.employeeOrgData",
    "division": "Sales Division",
    "costCenter": "1234"
  },
  "jobTitle": "Sales Agent",
  "mail": "salesagent@contoso.com",
  "mailNickname": "SalesAgent",
  "mobilePhone": "+1 425 555 0110",
  "officeLocation": "18/2111",
  "otherMails": [
    "salesagent@contoso.com"
  ],
  "postalCode": "98052",
  "preferredLanguage": "en-US",
  "state": "WA",
  "streetAddress": "9256 Towne Center Dr., Suite 400",
  "surname": "Agent",
  "usageLocation": "US",
  "userPrincipalName": "salesagent@contoso.com",
  "userType": "Member"
}

const options = {
	authProvider,
};

const client = Client.init(options);

const agentUser = {
  '@odata.type': '#microsoft.graph.agentUser',
  accountEnabled: true,
  assignedLicenses: [
    {
      '@odata.type': 'microsoft.graph.assignedLicense'
    }
  ],
  businessPhones: [
    '+1 425 555 0109'
  ],
  city: 'Seattle',
  companyName: 'Contoso',
  country: 'United States',
  department: 'Sales',
  displayName: 'Sales Agent',
  employeeId: '12345',
  employeeType: 'Agent',
  givenName: 'Sales',
  employeeHireDate: '2024-01-15T00:00:00Z',
  employeeLeaveDateTime: null,
  employeeOrgData: {
    '@odata.type': 'microsoft.graph.employeeOrgData',
    division: 'Sales Division',
    costCenter: '1234'
  },
  jobTitle: 'Sales Agent',
  mail: 'salesagent@contoso.com',
  mailNickname: 'SalesAgent',
  mobilePhone: '+1 425 555 0110',
  officeLocation: '18/2111',
  otherMails: [
    'salesagent@contoso.com'
  ],
  postalCode: '98052',
  preferredLanguage: 'en-US',
  state: 'WA',
  streetAddress: '9256 Towne Center Dr., Suite 400',
  surname: 'Agent',
  usageLocation: 'US',
  userPrincipalName: 'salesagent@contoso.com',
  userType: 'Member'
};

await client.api('/users/microsoft.graph.agentUser/{userId}')
	.version('beta')
	.update(agentUser);

応答

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

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.agentUser",
  "id": "929393ae-1e1d-159f-0d83-29f7df42e7b9",
  "signInActivity": {
    "@odata.type": "microsoft.graph.signInActivity"
  },
 "cloudLicensing": {
      "@odata.type": "microsoft.graph.cloudLicensing.userCloudLicensing"
    },
    "accountEnabled": "Boolean",
    "ageGroup": null,
    "assignedLicenses": [
      {
        "@odata.type": "microsoft.graph.assignedLicense"
      }
    ],
    "assignedPlans": [
      {
        "@odata.type": "microsoft.graph.assignedPlan"
      }
    ],
    "authorizationInfo": null,
    "businessPhones": [
      "String"
    ],
    "city": "String",
    "cloudRealtimeCommunicationInfo": {
      "@odata.type": "microsoft.graph.cloudRealtimeCommunicationInfo"
    },
    "companyName": "String",
    "consentProvidedForMinor": null,
    "country": "String",
    "createdDateTime": "String (timestamp)",
    "creationType": "String",
    "department": "String",
    "displayName": "String",
    "employeeHireDate": "String (timestamp)",
    "employeeId": "String",
    "employeeOrgData": {
      "@odata.type": "microsoft.graph.employeeOrgData"
    },
    "employeeType": "String",
    "employeeLeaveDateTime": "String (timestamp)",
    "faxNumber": "String",
    "givenName": "String",
    "identities": [
      {
        "@odata.type": "microsoft.graph.objectIdentity"
      }
    ],
    "imAddresses": [
      "String"
    ],
    "infoCatalogs": [
      "String"
    ],
    "isLicenseReconciliationNeeded": "Boolean",
    "isManagementRestricted": "Boolean",
    "isResourceAccount": "Boolean",
    "jobTitle": "String",
    "lastPasswordChangeDateTime": null,
    "legalAgeGroupClassification": null,
    "licenseAssignmentStates": [
      {
        "@odata.type": "microsoft.graph.licenseAssignmentState"
      }
    ],
    "mail": "String",
    "mailNickname": "String",
    "mobilePhone": "String",
    "onPremisesDistinguishedName": null,
    "onPremisesExtensionAttributes": null,
    "onPremisesImmutableId": null,
    "onPremisesLastSyncDateTime": null,
    "onPremisesProvisioningErrors": null,
    "onPremisesSecurityIdentifier": null,
    "onPremisesSipInfo": null,
    "onPremisesSyncEnabled": null,
    "onPremisesDomainName": null,
    "onPremisesSamAccountName": null,
    "onPremisesUserPrincipalName": null,
    "otherMails": [
      "String"
    ],
    "passwordPolicies": null,
    "passwordProfile": null,
    "officeLocation": "String",
    "postalCode": "String",
    "preferredDataLocation": "String",
    "preferredLanguage": "String",
    "provisionedPlans": [
      {
        "@odata.type": "microsoft.graph.provisionedPlan"
      }
    ],
    "proxyAddresses": [
      "String"
    ],
    "refreshTokensValidFromDateTime": "String (timestamp)",
    "securityIdentifier": "String",
    "serviceProvisioningErrors": [
      {
        "@odata.type": "microsoft.graph.serviceProvisioningXmlError"
      }
    ],
    "showInAddressList": "Boolean",
    "signInSessionsValidFromDateTime": "String (timestamp)",
    "state": "String",
    "streetAddress": "String",
    "surname": "String",
    "usageLocation": "String",
    "userPrincipalName": "String",
    "externalUserState": null,
    "externalUserStateChangeDateTime": null,
    "userType": "String",
    "identityParentId": "String",
    "mailboxSettings": {
      "@odata.type": "microsoft.graph.mailboxSettings"
    },
    "aboutMe": "String",
    "birthday": "String (timestamp)",
    "interests": [
      "String"
    ],
    "mySite": "String",
    "pastProjects": [
      "String"
    ],
    "preferredName": "String",
    "responsibilities": [
      "String"
    ],
    "schools": [
      "String"
    ],
    "skills": [
      "String"
    ]
  }