Update User

Update an Office 365 user's properties.

Input

Field Definition Type Required
User
Id or Username User ID or username of the Office 365 user. This is the user's User Principal Name (UPN). A UPN is formed by taking the username and domain and combining them with the @ separator.

For example, john.doe@somedomain.com. This could be the user's email address, but this is not true in all cases.

String TRUE
Properties
About Me Field for the user to describe themselves. String FALSE
Age Group Age group of the user. Allowed values: null, minor, notAdult and adult. String FALSE
Birthday User's birthday. This is a timestamp value that follows the ISO 8601 format and is in UTC time.

For example, midnight UTC on January 1, 2014 is expressed as 2014-01-01T00:00:00Z

String FALSE
Business Phones Telephone numbers for the user.
Note

Although this is a string collection, only one number can be set for this property.

List of text FALSE
City City in which the user is located. String FALSE
Company Name Company name which the user is associated. This property can be useful for describing the company that an external user comes from. String FALSE
Consent Provided For Minor Indicates if consent has been obtained for minors. Allowed values: null, granted, denied and notRequired. String FALSE
Country Country or region in which the user is located.

For example, US or UK.

String FALSE
Department Name for the department in which the user works. String FALSE
Display Name Name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial and last name. String FALSE
Employee Id Employee identifier assigned to the user by the organization. String FALSE
Fax Number Fax number of the user. String FALSE
Given Name Given name (first name) of the user. String FALSE
Hire Date User's hire date. This is a timestamp value that follows the ISO 8601 format and is in UTC time.

For example, midnight UTC on January 1, 2014 is expressed as 2014-01-01T00:00:00Z.

String FALSE
Interests List of the user's interests. List of text FALSE
Is Resource Account true if the user is a resource account; otherwise, false. null value should be considered false. Boolean FALSE
Job Title User's job title. String FALSE
Mail Nickname Mail alias for the user. String FALSE
Mobile Phone Primary cellular telephone number for the user. String FALSE
My Site URL for the user's personal site. String FALSE
Office Location Office location in the user's place of business. String FALSE
On Premises Immutable Id Property is used to associate an on-premises Active Directory user account to their Azure AD user object. This property must be specified when creating a new user account in the Graph if you are using a federated domain for the user's User PrincipalName (UPN) property. String FALSE
Other Mails List of additional email addresses for the user. List of text FALSE
Password Policies Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword. String FALSE
Password This specifies the password policies for the user. DisableStrongPassword allows weaker passwords than the default policy to be used. DisablePasswordExpiration sets the user's password to never expire. You can specify both by entering DisablePasswordExpiration, DisableStrongPassword. String FALSE
Force Change Password Next Sign In true if the user must change their password on the next login; otherwise false. Boolean FALSE
Force Change Password Next Sign In With MFA If true, at next sign-in, the user must perform a multi-factor authentication (MFA) before being forced to change their password. The behavior is identical to forceChangePasswordNextSignIn except that the user is required to first perform a multi-factor authentication before password change. After a password change, this property will be automatically reset to false. If this property is not set, the default value is false. Boolean FALSE
Past Projects List for the user to enumerate their past projects List of text FALSE
Postal Code Postal code for the user's postal address. The postal code is specific to the user's country or region. In the United States of America, this attribute contains the ZIP code. String FALSE
Preferred Data Location Preferred data location for the user. String FALSE
Preferred Language User's preferred language. This is an ISO 639-1 code.

For example, en-US.

String FALSE
Preferred Name Preferred name for the user. String FALSE
Responsibilities List for the user to enumerate their responsibilities. List of text FALSE
Schools List for the user to enumerate the schools they have attended. List of text FALSE
Show In Address List true if the Outlook global address list should contain this user, otherwise false. If not set, this will be treated as true. For users invited through the invitation manager, this property will be set to false. Boolean FALSE
Skills List for the user to enumerate their skills. List of text FALSE
State State or province in the user's address. String FALSE
Street Address Street address of the user's place of business. String FALSE
Surname User's surname (family name or last name). String FALSE
Usage Location (2 char) Two letter country code defined by ISO 3166. This is required for users that will be assigned licenses, due to a legal requirement to check for availability of services in a country.

For example, US, JP, and GB.

String FALSE
User Principal Name User Principal Name (UPN) of the user. This is an internet-style login name for the user based on RFC 822. Its format is alias@domain, where domain must be present in the tenant's collection of verified domains. This is sometimes the same as the user's email address. String FALSE
User Type String value that can be used to classify user types in your directory, such as Member and Guest. String FALSE
On Premises Extension Attributes Extension attributes 1-15 for the user. Note that the individual extension attributes are neither selectable nor filterable. For an onPremisesSyncEnabled user, this set of properties is on-premises-sourced and is read-only. For a cloud-only user (where onPremisesSyncEnabled is false), these properties may be set during creation or update. String FALSE
Extension Attribute 1 First customizable extension attribute. String FALSE
Extension Attribute 2 Second customizable extension attribute. String FALSE
Extension Attribute 3 Third customizable extension attribute. String FALSE
Extension Attribute 4 Fourth customizable extension attribute. String FALSE
Extension Attribute 5 Fifth customizable extension attribute. String FALSE
Extension Attribute 6 Sixth customizable extension attribute. String FALSE
Extension Attribute 7 Seventh customizable extension attribute. String FALSE
Extension Attribute 8 Eighth customizable extension attribute. String FALSE
Extension Attribute 9 Ninth customizable extension attribute. String FALSE
Extension Attribute 10 Tenth customizable extension attribute. String FALSE
Extension Attribute 11 Eleventh customizable extension attribute. String FALSE
Extension Attribute 12 Twelfth customizable extension attribute. String FALSE
Extension Attribute 13 Thirteenth customizable extension attribute. String FALSE
Extension Attribute 14 Fourteenth customizable extension attribute. String FALSE
Extension Attribute 15 Fifteenth customizable extension attribute. String FALSE

Output

Field Definition Type
Output
Status Code Result of the operation. The HTTP status code is returned by the connector and indicates whether the action taken by the card succeeded or failed. For example:
  • A 201 Created status code indicates success where a new resource was created.
  • A 403 Forbidden error indicates that the HTTP request was not processed because the necessary permissions were missing.

For a full list of possible status codes, see HTTP status codes.

Number

Related topics

Office 365 Admin connector

About the elements of Okta Workflows

Office 365 Admin Management API overview