Skip to main content

Update User

Update the directory-based user information using the user attributes associated with their userId. User information is replaced attribute-by-attribute, with the exception of immutable and read-only attributes. Existing values of unspecified attributes are cleaned.

External Documentation

Basic Parameters

ParameterDescription
User IDUnique ID to identiy the users. Use the Get users API to get the userId.
User NameUnique identifier defined by the provisioning client. Atlassian SCIM service will verify the value and guarantee its uniqueness. This is a required field during user creation or modification.

Advanced Parameters

ParameterDescription
ActiveA Boolean value indicating the user's administrative status.
AttributesResource attributes to be included in the response. Mutually exclusive from excludedAttributes. Example: userName,emails.value.
DepartmentUser's department.
Display NameUser's display name.
EmailsEmail addresses of the User. This is a required field during user creation or modification. One value must be marked as primary. For more information Atlassian documentation.
Excluded AttributesResource attributes to be excluded in the response. Mutually exclusive from attributes. Example: timezone,emails.type,department.
NameThe components of the user's name. For more information Atlassian documentation.
Nick NameUser's nickname.
OrganizationUser's organization.
Phone NumbersPhone numbers of the user. For more information Atlassian documentation.
Preferred LanguageUser's preferred language.
TimezoneUser's timezone. e.g. America/Los_Angeles .
TitleUser's title.

Example Output

{
"active": false,
"department": "User's department.",
"displayName": "User's display name.",
"emails": [
{
"primary": false,
"type": "Type of email address, for example \"work\" or \"personal\".",
"value": "Email address."
}
],
"externalId": "Identifier defined by provisioning client. This is a case-sensitive field. Uniqueness is controlled by client.\n",
"groups": [
{
"$ref": "string",
"display": "string",
"type": "string",
"value": "string"
}
],
"id": "Unique identifier defined by Atlassian SCIM Service. CaseExact. This is a read-only field and will be disregarded if included in the payload during user creation or modification..\n",
"meta": {
"created": "The DateTime that the resource was added to Atlassian SCIM service. This is a read-only field.\n",
"lastModified": "The most recent DateTime that the details of this resource were updated. This is a read-only field.\n",
"location": "The URI of the resource being returned. This is a read-only field.",
"resourceType": "The name of the resource type of the resource. This is a read-only and case-sensitive field.\n"
},
"name": {
"familyName": "The family name of the User.",
"formatted": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.",
"givenName": "The given name of the User.",
"honorificPrefix": "The honorific prefix(es) of the User, or title in most Western languages.",
"honorificSuffix": "The honorific suffix(es) of the User, or suffix in most Western languages.",
"middleName": "The middle name(s) of the User."
},
"nickName": "User's nickname.",
"organization": "User's organization.",
"phoneNumbers": [
{
"primary": false,
"type": "Type of phone number, for example `work` or `personal`",
"value": "Phone number."
}
],
"preferredLanguage": "User's preferred language.",
"schemas": [
"string"
],
"timezone": "User's timezone. e.g. America/Los_Angeles .",
"title": "User's title.",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"department": "Department the user belongs to.",
"organization": "Organization the user belongs to."
},
"urn:scim:schemas:extension:atlassian-external:1.0": {
"atlassianAccountId": "string"
},
"userName": "Unique identifier defined by the provisioning client. Atlassian SCIM service will verify the value and guarantee its uniqueness. This is a required field during user creation or modification.\n"
}

Automation Library Example

Update User with Atlassian User Provisioning and Send Results Via Email

Automation LibraryPreview this Automation on desktop