Rate this page:

Users

The following user attributes can be updated through the user provisioning API.

User profile fieldSCIM fieldAttribute typeRequired
Display namedisplayNameSingularfalse
Email addressemailsMulti-Valuedtrue
OrganizationorganizationSingularfalse
Job titletitleSingularfalse
TimezonetimezoneSingularfalse
DepartmentdepartmentSingularfalse
Preferred languagepreferredLanguageSingularfalse

Get a user by ID

GET /scim/directory/{directoryId}/Users/{userId}

Get a user from a directory by userId.

OAuth scopes required
None

Request

Path parameters
directoryId Required

string

Directory Id

userId Required

string

The user ID

Query parameters
attributes

string

Resource attributes to be included in response. Mutually exclusive with excludedAttributes. Example: userName,emails.value

excludedAttributes

string

Resource attributes to be excluded from response. Mutually exclusive with attributes. Example: timezone,emails.type,department

Example

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'

Responses

User has been returned successfully.

Content typeValue
application/json

Scim user

application/scim+json

Scim user

Update user via user attributes

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.

OAuth scopes required
None

Request

Path parameters
directoryId Required

string

Directory Id

userId Required

string

User ID

Query parameters
attributes

string

Resource attributes to be included in the response. Mutually exclusive with excludedAttributes. Example: userName,emails.value

excludedAttributes

string

Resource attributes to be excluded in the response. Mutually exclusive with attributes. Example: timezone,emails.type,department

Body parameters
Content typeValue
application/json

Scim user

application/scim+json

Scim user

Example

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
}'

Responses

User has been updated successfully.

Content typeValue
application/json

Scim user

application/scim+json

Scim user

Deactivate a user

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.

OAuth scopes required
None

Request

Path parameters
directoryId Required

string

Directory Id

userId Required

string

User Id

Example

1
2
3
curl --request DELETE \
  --url 'https://api.atlassian.com/scim/directory/{directoryId}/Users/{userId}' \
  --header 'Authorization: Bearer <access_token>'

Responses

User has been deactivated.

Update user by ID (PATCH)

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.

OAuth scopes required
None

Request

Path parameters
directoryId Required

string

Directory Id

userId Required

string

User Id

Query parameters
attributes

string

Resource attributes to be included in the response. Mutually exclusive with excludedAttributes. Example: userName,emails.value

excludedAttributes

string

Resource attributes to be included in the response. Mutually exclusive with attributes. Example: timezone,emails.type,department

Body parameters
Content typeValue
application/json

Request payload to patch.

application/scim+json

Request payload to patch.

Example

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

Responses

User has been updated successfully.

Content typeValue
application/json

Scim user

application/scim+json

Scim user

Get users

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.

OAuth scopes required
None

Request

Path parameters
directoryId Required

string

Directory Id

Query parameters
attributes

string

Resource attributes to be included in response. Mutually exclusive with excludedAttributes. Example: userName,emails.value

excludedAttributes

string

Resource attributes to be excluded from response. Mutually exclusive with attributes. Example: timezone,emails.type,department

filter

string

Filter for userName or externalId. Example: userName eq "Atlassian"

startIndex

integer

A 1-based index of the first query result.

Default: 1, Format: int32
count

integer

Desired maximum number of query results in the list response page.

Format: int32

Example

1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/scim/directory/{directoryId}/Users' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

Users have been returned successfully.

Content typeValue
application/json

Scim user list response

application/scim+json

Scim user list response

Create a user

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.

OAuth scopes required
None

Request

Path parameters
directoryId Required

string

Directory Id

Query parameters
attributes

string

Resource attributes to be included in response. Mutually exclusive with excludedAttributes. Example: userName,emails.value

excludedAttributes

string

Resource attributes to be excluded from response. Mutually exclusive with attributes. Example: timezone,emails.type,department

Body parameters
Content typeValue
application/json

Scim user

application/scim+json

Scim user

Example

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
}'

Responses

User has been created successfully.

Content typeValue
application/json

Scim user

application/scim+json

Scim user

Rate this page: