Rate this page:
The following user attributes can be updated through the user provisioning API.
| User profile field | SCIM field | Attribute type | Required |
|---|---|---|---|
| Display name | displayName | Singular | false |
| Email address | emails | Multi-Valued | true |
| Organization | organization | Singular | false |
| Job title | title | Singular | false |
| Timezone | timezone | Singular | false |
| Department | department | Singular | false |
| Preferred language | preferredLanguage | Singular | false |
GET /scim/directory/{directoryId}/Users/{userId}
Get a user from a directory by userId.
string
Directory Id
string
The user ID
string
Resource attributes to be included in response. Mutually exclusive with excludedAttributes. Example: userName,emails.value
string
Resource attributes to be excluded from response. Mutually exclusive with attributes. Example: timezone,emails.type,department
1 2 3 4
curl --request GET \
--url 'https://api.atlassian.com/scim/directory/{directoryId}/Users/{userId}?attributes={attributes}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'PUT /scim/directory/{directoryId}/Users/{userId}
Updates a user's information in a directory by userId via user attributes. User information is replaced attribute-by-attribute, with the exception of immutable and read-only attributes. Existing values of unspecified attributes are cleaned.
string
Directory Id
string
User ID
string
Resource attributes to be included in the response. Mutually exclusive with excludedAttributes. Example: userName,emails.value
string
Resource attributes to be excluded in the response. Mutually exclusive with attributes. Example: timezone,emails.type,department
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
curl --request PUT \
--url 'https://api.atlassian.com/scim/directory/{directoryId}/Users/{userId}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"userName": "<string>",
"emails": [
{
"value": "<string>",
"type": "<string>",
"primary": true
}
],
"name": {
"formatted": "<string>",
"familyName": "<string>",
"givenName": "<string>",
"middleName": "<string>",
"honorificPrefix": "<string>",
"honorificSuffix": "<string>"
},
"displayName": "<string>",
"nickName": "<string>",
"title": "<string>",
"preferredLanguage": "<string>",
"department": "<string>",
"organization": "<string>",
"timezone": "<string>",
"phoneNumbers": [
{
"value": "<string>",
"type": "<string>",
"primary": true
}
],
"active": true
}'DELETE /scim/directory/{directoryId}/Users/{userId}
Deactivate a user by userId. The user is not available for future requests until activated again. Any future operation for the deactivated user returns the 404 (resource not found) error.
string
Directory Id
string
User Id
1 2 3
curl --request DELETE \
--url 'https://api.atlassian.com/scim/directory/{directoryId}/Users/{userId}' \
--header 'Authorization: Bearer <access_token>'User has been deactivated.
PATCH /scim/directory/{directoryId}/Users/{userId}
This operation updates a user's information in a directory by userId via PATCH. Refer to GET /ServiceProviderConfig for details on the supported operations.
string
Directory Id
string
User Id
string
Resource attributes to be included in the response. Mutually exclusive with excludedAttributes. Example: userName,emails.value
string
Resource attributes to be included in the response. Mutually exclusive with attributes. Example: timezone,emails.type,department
| Content type | Value |
|---|---|
| application/json | |
| application/scim+json |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
curl --request PATCH \
--url 'https://api.atlassian.com/scim/directory/{directoryId}/Users/{userId}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"schemas": [
"<string>"
],
"operations": [
{
"op": "<string>",
"path": "<string>",
"value": {
"array": true,
"null": true,
"valueNode": true,
"containerNode": true,
"missingNode": true,
"object": true,
"nodeType": "ARRAY",
"pojo": true,
"number": true,
"integralNumber": true,
"floatingPointNumber": true,
"short": true,
"int": true,
"long": true,
"double": true,
"bigDecimal": true,
"bigInteger": true,
"textual": true,
"boolean": true,
"binary": true,
"float": true
}
}
]
}'GET /scim/directory/{directoryId}/Users
Get users from the specified directory. Filtering is supported with a single exact match (eq) against the userName and externalId attributes. Pagination is supported. Sorting is not supported.
string
Directory Id
string
Resource attributes to be included in response. Mutually exclusive with excludedAttributes. Example: userName,emails.value
string
Resource attributes to be excluded from response. Mutually exclusive with attributes. Example: timezone,emails.type,department
string
Filter for userName or externalId. Example: userName eq "Atlassian"
integer
A 1-based index of the first query result.
1, Format: int32integer
Desired maximum number of query results in the list response page.
int321 2 3 4
curl --request GET \
--url 'https://api.atlassian.com/scim/directory/{directoryId}/Users' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'Users have been returned successfully.
| Content type | Value |
|---|---|
| application/json | |
| application/scim+json |
POST /scim/directory/{directoryId}/Users
Create a user in a directory. An attempt to create an existing user fails with a 409 (Conflict) error. A user account can only be created if it has an email address on a verified domain. If a managed Atlassian account already exists on the Atlassian platform for the specified email address, the user in your identity provider is linked to the user in your Atlassian organization.
string
Directory Id
string
Resource attributes to be included in response. Mutually exclusive with excludedAttributes. Example: userName,emails.value
string
Resource attributes to be excluded from response. Mutually exclusive with attributes. Example: timezone,emails.type,department
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
curl --request POST \
--url 'https://api.atlassian.com/scim/directory/{directoryId}/Users' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"userName": "<string>",
"emails": [
{
"value": "<string>",
"type": "<string>",
"primary": true
}
],
"name": {
"formatted": "<string>",
"familyName": "<string>",
"givenName": "<string>",
"middleName": "<string>",
"honorificPrefix": "<string>",
"honorificSuffix": "<string>"
},
"displayName": "<string>",
"nickName": "<string>",
"title": "<string>",
"preferredLanguage": "<string>",
"department": "<string>",
"organization": "<string>",
"timezone": "<string>",
"phoneNumbers": [
{
"value": "<string>",
"type": "<string>",
"primary": true
}
],
"active": true
}'Rate this page: