• Users
  • Groups
  • Schemas
  • Service Provider Configuration
Cloud
User provisioning REST API / Reference / REST API

Rate this page:

Groups

Postman Collection
OpenAPI
Operations
GET/scim/directory/{directoryId}/Groups/{id}PUT/scim/directory/{directoryId}/Groups/{id}DEL/scim/directory/{directoryId}/Groups/{id}PATCH/scim/directory/{directoryId}/Groups/{id}GET/scim/directory/{directoryId}/GroupsPOST/scim/directory/{directoryId}/Groups
GET

Get a group by ID

Get a group from a directory by group ID.

Request

Path parameters

directoryId

string

Required
id

string

Required

Responses

Group has been returned successfully.

application/json application/scim+json

Scim group

SCIM group

GET/scim/directory/{directoryId}/Groups/{id}
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/scim/directory/{directoryId}/Groups/{id}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 { "schemas": [ "<string>" ], "id": "<string>", "externalId": "<string>", "displayName": "<string>", "members": [ { "type": "<string>", "value": "<string>", "display": "<string>", "$ref": "<string>" } ], "meta": { "resourceType": "USER", "location": "<string>", "lastModified": "<string>", "created": "<string>" } }
PUT

Update a group by ID

Update a group in a directory by group ID.

Request

Path parameters

directoryId

string

Required
id

string

Required

Request bodyapplication/json application/scim+json

displayName

string

Responses

Group has been updated successfully.

application/json application/scim+json

Scim group

SCIM group

PUT/scim/directory/{directoryId}/Groups/{id}
1 2 3 4 5 6 7 8 curl --request PUT \ --url 'https://api.atlassian.com/scim/directory/{directoryId}/Groups/{id}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "displayName": "<string>" }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 { "schemas": [ "<string>" ], "id": "<string>", "externalId": "<string>", "displayName": "<string>", "members": [ { "type": "<string>", "value": "<string>", "display": "<string>", "$ref": "<string>" } ], "meta": { "resourceType": "USER", "location": "<string>", "lastModified": "<string>", "created": "<string>" } }
DEL

Delete a group by ID

Delete a group from a directory. An attempt to delete a non-existent group fails with a 404 (Resource Not found) error.

Note: Deleting a synced group from your identity provider will delete the group from your organization's directory and associated sites.

  1. If this group is used for allocating product license (granting role in a product), then members of this group may lose access to corresponding product after group deletion.
  2. If this group is used to grant permissions in product, then members of this group may lose their permissions in the corresponding product.

Request

Path parameters

directoryId

string

Required
id

string

Required

Responses

Group has been deleted successfully.

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

Update a group by ID (PATCH)

Update a group's information in a directory by groupId via PATCH. You can use this API to manage group membership.

Note: Renaming groups after they've synced to your Atlassian organization isn't supported in this release of the User Provisioning API. To rename a group, create a new group with the desired name, update membership, and then delete the old group.

Example

Some HTTP headers omitted and JSON payloads formatted for readability.

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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# Request
PATCH /scim/directory/2fb21891-7bee-4c2d-a61a-ade3834c8b2b/Groups/50202593-bc47-45df-8fa0-3f63343aa3c1 HTTP/1.1
Accept: application/scim+json
Accept-Charset: utf-8
Content-Type: application/scim+json; charset=utf-8
Authorization: Bearer 0j6lDgrjU7HmGagocgLe
Host: api.atlassian.com

{
   "schemas":[
      "urn:ietf:params:scim:api:messages:2.0:PatchOp"
   ],
   "Operations":[
      {
         "op":"add",
         "path":"members",
         "value":[
            {
               "value":"c6993c94-dbda-40f1-b6f0-18c855522ade",
               "display":"dave.meyer@demotime.authteam.com"
            },
            {
               "value":"f0ae48f7-1466-445e-85ea-e83ef754aefd",
               "display":"lingbo.lu@demotime.authteam.com"
            },
            {
               "value":"432d6f10-2e28-454e-be99-0f8c732a046f",
               "display":"joanna@demotime.authteam.com"
            }
         ]
      }
   ]
}

# Response
HTTP/1.1 200
Content-Type: application/scim+json

{
   "schemas":[
      "urn:ietf:params:scim:schemas:core:2.0:Group"
   ],
   "id":"50202593-bc47-45df-8fa0-3f63343aa3c1",
   "displayName":"demotime-confluence-users",
   "members":[
      {
         "type":"User",
         "value":"f0ae48f7-1466-445e-85ea-e83ef754aefd",
         "display":"lingbo.lu@demotime.authteam.com",
         "$ref":"https://api.atlassian.com/scim/directory/2fb21891-7bee-4c2d-a61a-ade3834c8b2b/Users/f0ae48f7-1466-445e-85ea-e83ef754aefd"
      },
      {
         "type":"User",
         "value":"c6993c94-dbda-40f1-b6f0-18c855522ade",
         "display":"dave.meyer@demotime.authteam.com",
         "$ref":"https://api.atlassian.com/scim/directory/2fb21891-7bee-4c2d-a61a-ade3834c8b2b/Users/c6993c94-dbda-40f1-b6f0-18c855522ade"
      },
      {
         "type":"User",
         "value":"432d6f10-2e28-454e-be99-0f8c732a046f",
         "display":"joanna@demotime.authteam.com",
         "$ref":"https://api.atlassian.com/scim/directory/2fb21891-7bee-4c2d-a61a-ade3834c8b2b/Users/432d6f10-2e28-454e-be99-0f8c732a046f"
      }
   ],
   "meta":{
      "resourceType":"Group",
      "location":"https://api.atlassian.com/scim/directory/2fb21891-7bee-4c2d-a61a-ade3834c8b2b/Groups/50202593-bc47-45df-8fa0-3f63343aa3c1",
      "lastModified":"2018-09-26T17:49:09.420654Z",
      "created":"2018-09-26T17:41:35.49073Z"
   }
}

Request

Path parameters

directoryId

string

Required
id

string

Required

Request bodyapplication/json application/scim+json

schemas

array<string>

operations

array<Operation for a Scim patch.>

Responses

Group has been updated successfully.

application/json application/scim+json

Scim group

SCIM group

PATCH/scim/directory/{directoryId}/Groups/{id}
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}/Groups/{id}' \ --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 } } ] }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 { "schemas": [ "<string>" ], "id": "<string>", "externalId": "<string>", "displayName": "<string>", "members": [ { "type": "<string>", "value": "<string>", "display": "<string>", "$ref": "<string>" } ], "meta": { "resourceType": "USER", "location": "<string>", "lastModified": "<string>", "created": "<string>" } }
GET

Get groups

Get groups from a directory. Filtering is supported with a single exact match (eq) against the displayName attribute. Pagination is supported. Sorting is not supported.

Request

Path parameters

directoryId

string

Required

Query parameters

filter

string

startIndex

integer

count

integer

Responses

Groups have been returned successfully.

application/json application/scim+json

Scim group list response

SCIM group list response

GET/scim/directory/{directoryId}/Groups
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/scim/directory/{directoryId}/Groups' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
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 { "schemas": [ "<string>" ], "totalResults": 200, "startIndex": 73, "itemsPerPage": 57, "Resources": [ { "schemas": [ "<string>" ], "id": "<string>", "externalId": "<string>", "displayName": "<string>", "members": [ { "type": "<string>", "value": "<string>", "display": "<string>", "$ref": "<string>" } ], "meta": { "resourceType": "USER", "location": "<string>", "lastModified": "<string>", "created": "<string>" } } ] }
POST

Create a group

Create a group in a directory. An attempt to create a group with an existing name fails with a 409 (Conflict) error.

Request

Path parameters

directoryId

string

Required

Request bodyapplication/json application/scim+json

displayName

string

Responses

Group has been created successfully.

application/json application/scim+json

Scim group

SCIM group

POST/scim/directory/{directoryId}/Groups
1 2 3 4 5 6 7 8 curl --request POST \ --url 'https://api.atlassian.com/scim/directory/{directoryId}/Groups' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "displayName": "<string>" }'
201Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 { "schemas": [ "<string>" ], "id": "<string>", "externalId": "<string>", "displayName": "<string>", "members": [ { "type": "<string>", "value": "<string>", "display": "<string>", "$ref": "<string>" } ], "meta": { "resourceType": "USER", "location": "<string>", "lastModified": "<string>", "created": "<string>" } }