Update agentUser

Namespace: microsoft.graph

Aktualisieren Sie die Eigenschaften eines agentUser-Objekts .

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungen für bestimmte Szenarien

• Ihr persönliches Microsoft-Konto muss an einen Microsoft Entra Mandanten gebunden sein, um Ihr Profil mit der delegierten Berechtigung User.ReadWrite für ein persönliches Microsoft-Konto zu aktualisieren.
• So aktualisieren Sie die employeeLeaveDateTime-Eigenschaft :
  • In delegierten Szenarien benötigt der Administrator die Rolle des globalen Administrators . Der App müssen die delegierten Berechtigungen User.Read.All und User-LifeCycleInfo.ReadWrite.All erteilt werden.
  • In Nur-App-Szenarien mit Microsoft Graph-Berechtigungen müssen der App die Berechtigungen User.Read.All und User-LifeCycleInfo.ReadWrite.All erteilt werden.
• So aktualisieren Sie die customSecurityAttributes-Eigenschaft :
  • In delegierten Szenarien muss dem Administrator die Rolle des Attributzuweisungsadministrators zugewiesen und der App die Berechtigung CustomSecAttributeAssignment.ReadWrite.All erteilt werden.
  • In Nur-App-Szenarien mit Microsoft Graph-Berechtigungen muss der App die Berechtigung CustomSecAttributeAssignment.ReadWrite.All erteilt werden.
• User-Mail.ReadWrite.All ist die Berechtigung mit den geringsten Berechtigungen, um die Eigenschaft otherMails zu aktualisieren.
• User-PasswordProfile.ReadWrite.All ist die Berechtigung mit den geringsten Berechtigungen, um die passwordProfile-Eigenschaft zu aktualisieren.
• User-Phone.ReadWrite.All ist die Berechtigung mit den geringsten Berechtigungen zum Aktualisieren der Eigenschaften "businessPhones" und "mobilePhone".
• User.EnableDisableAccount.All + User.Read.All ist die am wenigsten privilegierte Kombination von Berechtigungen zum Aktualisieren der accountEnabled-Eigenschaft .
• User.ManageIdentities.All ist erforderlich , um die Eigenschaft identities zu aktualisieren.

HTTP-Anforderung

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

Anforderungsheader

Anforderungstext

Geben Sie im Anforderungstext nur die Werte für die zu aktualisierenden Eigenschaften an. Vorhandene Eigenschaften, die nicht im Anforderungstext enthalten sind, behalten ihre vorherigen Werte bei oder werden basierend auf Änderungen an anderen Eigenschaftswerten neu berechnet.

In der folgenden Tabelle sind die Eigenschaften angegeben, die aktualisiert werden können.

Sie müssen den @odata.type wie #microsoft.graph.agentUser im Anforderungstext angeben, wenn Sie einen agentUser aktualisieren.

Da die agentUser-RessourceErweiterungen unterstützt, können Sie den PATCH Vorgang verwenden, um Ihre eigenen App-spezifischen Daten in benutzerdefinierten Eigenschaften einer Erweiterung in einer vorhandenen agentUser-instance hinzuzufügen, zu aktualisieren oder zu löschen.

Erweiterungen und zugehörige Daten verwalten

Verwenden Sie diese API, um das Verzeichnis, das Schema und die geöffneten Erweiterungen sowie deren Daten für Agent-Benutzer wie folgt zu verwalten:

• Hinzufügen, Aktualisieren und Speichern von Daten in den Erweiterungen für einen vorhandenen Agentbenutzer
• Entfernen Sie für Verzeichnis- und Schemaerweiterungen alle gespeicherten Daten, indem Sie den Wert der benutzerdefinierten Erweiterungseigenschaft auf null festlegen. Für offene Erweiterungen die API zum Löschen offener Erweiterungen verwenden.

Antwort

Bei erfolgreicher Ausführung gibt diese Methode einen 200 OK Antwortcode und ein aktualisiertes agentUser-Objekt im Antworttext zurück.

Beispiele

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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);

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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