Rate this page:
GET /scim/directory/{directoryId}/Groups/{id}
Get a group from a directory by group ID.
string
Directory Id
string
Group 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'
Group has been returned successfully.
Content type | Value |
---|---|
application/json | |
application/scim+json |
PUT /scim/directory/{directoryId}/Groups/{id}
Update a group in a directory by group ID.
string
string
Group Id
Content type | Value |
---|---|
application/json | |
application/scim+json |
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>"
}'
Group has been updated successfully.
Content type | Value |
---|---|
application/json | |
application/scim+json |
DELETE /scim/directory/{directoryId}/Groups/{id}
Delete a group from a directory. An attempt to delete a non-existent group fails with a 404 (Resource Not found) error.
string
Directory Id
string
Group Id
1 2 3
curl --request DELETE \
--url 'https://api.atlassian.com/scim/directory/{directoryId}/Groups/{id}' \
--header 'Authorization: Bearer <access_token>'
Group has been deleted successfully.
PATCH /scim/directory/{directoryId}/Groups/{id}
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.
Some HTTP headers omitted and JSON payloads formatted for readability.
1 2# 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" } }
string
Directory ID
string
Group ID
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}/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
}
}
]
}'
Group has been updated successfully.
Content type | Value |
---|---|
application/json | |
application/scim+json |
GET /scim/directory/{directoryId}/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.
string
Directory Id
string
Filter for displayName
. Example: displayName eq "SCIM_GROUP"
integer
A 1-based index of the first query result.
1
, Format: int32
integer
Desired maximum number of query results in the list response page.
int32
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'
Groups have been returned successfully.
Content type | Value |
---|---|
application/json | |
application/scim+json |
POST /scim/directory/{directoryId}/Groups
Create a group in a directory. An attempt to create a group with an existing name fails with a 409 (Conflict) error.
string
Content type | Value |
---|---|
application/json | |
application/scim+json |
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>"
}'
Group has been created successfully.
Content type | Value |
---|---|
application/json | |
application/scim+json |
Rate this page: