{ "info": { "_postman_id": "6c249712-cdcd-46a8-88bb-a32af7a0c54b", "name": "User provisioning", "description": "Rest APIs", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" }, "item": [ { "name": "Users", "description": "The following user attributes can be updated through the user provisioning API.\n\n| User profile field | SCIM field | Attribute type | Required |\n|--------------------|-------------------|----------------|----------|\n| Display name | displayName | Singular | false |\n| Email address | emails | Multi-Valued | true |\n| Organization | organization | Singular | false |\n| Job title | title | Singular | false |\n| Timezone | timezone | Singular | false |\n| Department | department | Singular | false |\n| Preferred language | preferredLanguage | Singular | false |\n", "item": [ { "name": "Get a user by ID", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}scim/directory/:directoryId/Users/:userId", "query": [ { "key": "attributes", "value": "{{attributes}}", "disabled": true, "description": "Resource attributes to be included in response. Mutually exclusive with `excludedAttributes`. Example: `userName,emails.value`\n" }, { "key": "excludedAttributes", "value": "{{excludedAttributes}}", "disabled": true, "description": "Resource attributes to be excluded from response. Mutually exclusive with `attributes`. Example: `timezone,emails.type,department`\n" } ], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "The SCIM base URL that is generated when [conecting an identity provider with SCIM provisioning](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/#Connect-an-identity-provider-with-SCIM-provisioning).", "disabled": false }, { "key": "userId", "value": "{{userId}}", "description": "Unique ID to identiy the users. Use the [Get users API](https://developer.atlassian.com/cloud/admin/user-provisioning/rest/api-group-users/#api-scim-directory-directoryid-users-get) to get the userId.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves a user from the directory based on their `userId`. \n", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } } }, "response": [] }, { "name": "Update user via user attributes", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}scim/directory/:directoryId/Users/:userId", "query": [ { "key": "attributes", "value": "{{attributes}}", "disabled": true, "description": "Resource attributes to be included in the response. Mutually exclusive from `excludedAttributes`. Example: `userName,emails.value`\n" }, { "key": "excludedAttributes", "value": "{{excludedAttributes}}", "disabled": true, "description": "Resource attributes to be excluded in the response. Mutually exclusive from `attributes`. Example: `timezone,emails.type,department`\n" } ], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "The SCIM base URL that is generated when [conecting an identity provider with SCIM provisioning](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/#Connect-an-identity-provider-with-SCIM-provisioning).", "disabled": false }, { "key": "userId", "value": "{{userId}}", "description": "Unique ID to identiy the users. Use the [Get users API](https://developer.atlassian.com/cloud/admin/user-provisioning/rest/api-group-users/#api-scim-directory-directoryid-users-get) to get the userId.", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "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.\n", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete a user", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}scim/directory/:directoryId/Users/:userId", "query": [], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "The ID assigned to your identity provider when linked to your Atlassian organization.", "disabled": false }, { "key": "userId", "value": "{{userId}}", "description": "Unique ID to identiy the SCIM users. Use the [Get users API](https://developer.atlassian.com/cloud/admin/user-provisioning/rest/api-group-users/#api-scim-directory-directoryid-users-get) to get the userId.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deleting a user via the SCIM APIs will unlink the user from your identity provider and deactivate the user within Atlassian if they are managed by your organization.\n\nThe deleted user is not available for future requests until created with a new `userId`. If the user is deactivated they can be activated again via [Atlassian Administration](https://admin.atlassian.com/).\n\n**Note:** Executing this API call will result in the deletion of the SCIM record, and there is no method to reverse these changes except by creating a new SCIM record with [Create a user API](https://developer.atlassian.com/cloud/admin/user-provisioning/rest/api-group-users/#api-scim-directory-directoryid-users-post).\n", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } } }, "response": [] }, { "name": "Update user by ID (PATCH)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}scim/directory/:directoryId/Users/:userId", "query": [ { "key": "attributes", "value": "{{attributes}}", "disabled": true, "description": "Resource attributes to be included in the response. Mutually exclusive from `excludedAttributes`. Example: `userName,emails.value`\n" }, { "key": "excludedAttributes", "value": "{{excludedAttributes}}", "disabled": true, "description": "Resource attributes to be included in the response. Mutually exclusive from `attributes`. Example: `timezone,emails.type,department`\n" } ], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "The SCIM base URL that is generated when [conecting an identity provider with SCIM provisioning](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/#Connect-an-identity-provider-with-SCIM-provisioning).", "disabled": false }, { "key": "userId", "value": "{{userId}}", "description": "Unique ID to identiy the users. Use the [Get users API](https://developer.atlassian.com/cloud/admin/user-provisioning/rest/api-group-users/#api-scim-directory-directoryid-users-get) to get the userId.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates a user's information in the directory based on their `userId` via `PATCH`. Refer to [Service Provider Configuration APIs](https://developer.atlassian.com/cloud/admin/user-provisioning/rest/api-group-service-provider-configuration/#api-group-service-provider-configuration) for details on supported operations.\n", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}scim/directory/:directoryId/Users", "query": [ { "key": "attributes", "value": "{{attributes}}", "disabled": true, "description": "Resource attributes to be included in response. Mutually exclusive from `excludedAttributes`. Example: `userName,emails.value`\n" }, { "key": "excludedAttributes", "value": "{{excludedAttributes}}", "disabled": true, "description": "Resource attributes to be excluded from response. Mutually exclusive from `attributes`. Example: `timezone,emails.type,department`\n" }, { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "Filter for `userName` or `externalId`. Example: `userName eq \"Atlassian\"`\n" }, { "key": "startIndex", "value": "{{startIndex}}", "disabled": true, "description": "A 1-based index of the first query result." }, { "key": "count", "value": "{{count}}", "disabled": true, "description": "Desired maximum number of query results in the list response page." } ], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "The SCIM base URL that is generated when [conecting an identity provider with SCIM provisioning](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/#Connect-an-identity-provider-with-SCIM-provisioning).", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get users from the specified directory. Filtering is supported with a single exact match (`eq`) against the `userName` and `externalId` attributes.\n\n **Note**: While this API enables pagination, sorting functionality is not supported.\n", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } } }, "response": [] }, { "name": "Create a user", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}scim/directory/:directoryId/Users", "query": [ { "key": "attributes", "value": "{{attributes}}", "disabled": true, "description": "Resource attributes to be included in response. Mutually exclusive from `excludedAttributes`. Example: `userName,emails.value`\n" }, { "key": "excludedAttributes", "value": "{{excludedAttributes}}", "disabled": true, "description": "Resource attributes to be excluded from response. Mutually exclusive from `attributes`. Example: `timezone,emails.type,department`\n" } ], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "The SCIM base URL that is generated when [conecting an identity provider with SCIM provisioning](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/#Connect-an-identity-provider-with-SCIM-provisioning).", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Creates a user in the directory.\n**Note:** An attempt to create an existing user will fail with a 409 (Conflict) error.\n\nUse this API to manage accounts outside your organization when assigning these users to SCIM groups.\n\nIf there's already a managed Atlassian account associated with the specified email address on the Atlassian platform, the user in your identity provider will be connected or linked to the user in your Atlassian organization.", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Groups", "item": [ { "name": "Get a group by ID", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}scim/directory/:directoryId/Groups/:id", "query": [], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "The SCIM base URL that is generated when [conecting an identity provider with SCIM provisioning](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/#Connect-an-identity-provider-with-SCIM-provisioning).", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Unique SCIM id that serves as reference to the group. Use the [Get groups API](https://developer.atlassian.com/cloud/admin/user-provisioning/rest/api-group-groups/#api-scim-directory-directoryid-groups-get) to get the SCIM id.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets the details of a group based on the id.", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } } }, "response": [] }, { "name": "Update a group by ID", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}scim/directory/:directoryId/Groups/:id", "query": [], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "The SCIM base URL that is generated when [conecting an identity provider with SCIM provisioning](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/#Connect-an-identity-provider-with-SCIM-provisioning).", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Unique SCIM id that serves as reference to the group. Use the [Get groups API] (https://developer.atlassian.com/cloud/admin/user-provisioning/rest/api-group-groups/#api-scim-directory-directoryid-groups-get) to get the SCIM id.", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates the details of a group with its unique ID.", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete a group by ID", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}scim/directory/:directoryId/Groups/:id", "query": [], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "The SCIM base URL that is generated when [conecting an identity provider with SCIM provisioning](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/#Connect-an-identity-provider-with-SCIM-provisioning).", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Unique SCIM id that serves as reference to the group. Use the [Get groups API](https://developer.atlassian.com/cloud/admin/user-provisioning/rest/api-group-groups/#api-scim-directory-directoryid-groups-get) to get the SCIM id.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes a group to remove the group from the organization's directory.\n \n **Note**: An attempt to delete a non-existent group will fail with a 404 (Resource Not found) error.\n\n **Note**: Deleting a synced group from your identity provider will delete the group from your organization's directory and associated sites. \n 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. \n 2. If this group is used to grant permissions in product, then members of this group may lose their permissions in the corresponding product. ", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } } }, "response": [] }, { "name": "Update a group by ID (PATCH)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}scim/directory/:directoryId/Groups/:id", "query": [], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "The SCIM base URL that is generated when [conecting an identity provider with SCIM provisioning](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/#Connect-an-identity-provider-with-SCIM-provisioning).", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Unique SCIM id that serves as reference to the group. Use the [Get groups API](https://developer.atlassian.com/cloud/admin/user-provisioning/rest/api-group-groups/#api-scim-directory-directoryid-groups-get) to get the SCIM id.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates a group's information in the directory and manages group membership.\n\n**Note:** Renaming groups after they've synced to your Atlassian organization isn't supported in this \nrelease of User Provisioning API. To rename a group, create a new group with the desired \nname, update membership, and then delete the old group.\n\n#### Example\n\nSome HTTP headers omitted and JSON payloads formatted for readability.\n\n```\n# Request\nPATCH /scim/directory/2fb21891-7bee-4c2d-a61a-ade3834c8b2b/Groups/50202593-bc47-45df-8fa0-3f63343aa3c1 HTTP/1.1\nAccept: application/scim+json\nAccept-Charset: utf-8\nContent-Type: application/scim+json; charset=utf-8\nAuthorization: Bearer 0j6lDgrjU7HmGagocgLe\nHost: api.atlassian.com\n\n{\n \"schemas\":[\n \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n ],\n \"Operations\":[\n {\n \"op\":\"add\",\n \"path\":\"members\",\n \"value\":[\n {\n \"value\":\"c6993c94-dbda-40f1-b6f0-18c855522ade\",\n \"display\":\"dave.meyer@demotime.authteam.com\"\n },\n {\n \"value\":\"f0ae48f7-1466-445e-85ea-e83ef754aefd\",\n \"display\":\"lingbo.lu@demotime.authteam.com\"\n },\n {\n \"value\":\"432d6f10-2e28-454e-be99-0f8c732a046f\",\n \"display\":\"joanna@demotime.authteam.com\"\n }\n ]\n }\n ]\n}\n\n# Response\nHTTP/1.1 200\nContent-Type: application/scim+json\n\n{\n \"schemas\":[\n \"urn:ietf:params:scim:schemas:core:2.0:Group\"\n ],\n \"id\":\"50202593-bc47-45df-8fa0-3f63343aa3c1\",\n \"displayName\":\"demotime-confluence-users\",\n \"members\":[\n {\n \"type\":\"User\",\n \"value\":\"f0ae48f7-1466-445e-85ea-e83ef754aefd\",\n \"display\":\"lingbo.lu@demotime.authteam.com\",\n \"$ref\":\"https://api.atlassian.com/scim/directory/2fb21891-7bee-4c2d-a61a-ade3834c8b2b/Users/f0ae48f7-1466-445e-85ea-e83ef754aefd\"\n },\n {\n \"type\":\"User\",\n \"value\":\"c6993c94-dbda-40f1-b6f0-18c855522ade\",\n \"display\":\"dave.meyer@demotime.authteam.com\",\n \"$ref\":\"https://api.atlassian.com/scim/directory/2fb21891-7bee-4c2d-a61a-ade3834c8b2b/Users/c6993c94-dbda-40f1-b6f0-18c855522ade\"\n },\n {\n \"type\":\"User\",\n \"value\":\"432d6f10-2e28-454e-be99-0f8c732a046f\",\n \"display\":\"joanna@demotime.authteam.com\",\n \"$ref\":\"https://api.atlassian.com/scim/directory/2fb21891-7bee-4c2d-a61a-ade3834c8b2b/Users/432d6f10-2e28-454e-be99-0f8c732a046f\"\n }\n ],\n \"meta\":{\n \"resourceType\":\"Group\",\n \"location\":\"https://api.atlassian.com/scim/directory/2fb21891-7bee-4c2d-a61a-ade3834c8b2b/Groups/50202593-bc47-45df-8fa0-3f63343aa3c1\",\n \"lastModified\":\"2018-09-26T17:49:09.420654Z\",\n \"created\":\"2018-09-26T17:41:35.49073Z\"\n }\n}\n```", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}scim/directory/:directoryId/Groups", "query": [ { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "Filter for `displayName`. Example: `displayName eq \"SCIM_GROUP\"`" }, { "key": "startIndex", "value": "{{startIndex}}", "disabled": true, "description": "A 1-based index of the first query result." }, { "key": "count", "value": "{{count}}", "disabled": true, "description": "Desired maximum number of query results in the list response page." } ], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "The SCIM base URL that is generated when [conecting an identity provider with SCIM provisioning](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/#Connect-an-identity-provider-with-SCIM-provisioning).", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get groups from the directory. Filter the groups by name supported with a single exact match (`eq`) against the `displayName` attribute. \n\n**Note**: While this API enables pagination, sorting functionality is not supported.\n", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } } }, "response": [] }, { "name": "Create a group", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}scim/directory/:directoryId/Groups", "query": [], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "The SCIM base URL that is generated when [conecting an identity provider with SCIM provisioning](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/#Connect-an-identity-provider-with-SCIM-provisioning).", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Creates a read-only group in the organization's directory. You can only edit groups from your identity provider. \n\n**Note:** An attempt to create a group with an existing name will fail with a 409 (Conflict) error.\n", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Schemas", "item": [ { "name": "Get all schemas", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}scim/directory/:directoryId/Schemas", "query": [], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "The SCIM base URL that is generated when [conecting an identity provider with SCIM provisioning](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/#Connect-an-identity-provider-with-SCIM-provisioning).", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get all SCIM features metadata of your organization. \n\n**Note:** This API does not support filtering, pagination, or sorting.\n", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } } }, "response": [] }, { "name": "Get user schemas", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}scim/directory/:directoryId/Schemas/urn:ietf:params:scim:schemas:core:2.0:User", "query": [], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "The SCIM base URL that is generated when [conecting an identity provider with SCIM provisioning](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/#Connect-an-identity-provider-with-SCIM-provisioning).", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get the user schemas from the SCIM provider. \n\n**Note:** This API does not support filtering, pagination, or sorting.\n", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } } }, "response": [] }, { "name": "Get group schemas", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}scim/directory/:directoryId/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group", "query": [], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "The SCIM base URL that is generated when [conecting an identity provider with SCIM provisioning](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/#Connect-an-identity-provider-with-SCIM-provisioning).", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get the group schemas from the SCIM provider. \n\n**Note:** This API does not support filtering, pagination, or sorting.\n", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } } }, "response": [] }, { "name": "Get user enterprise extension schemas", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}scim/directory/:directoryId/Schemas/urn:ietf:params:scim:schemas:extension:enterprise:2.0:User", "query": [], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "The SCIM base URL that is generated when [conecting an identity provider with SCIM provisioning](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/#Connect-an-identity-provider-with-SCIM-provisioning).", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get the user enterprise extension schemas from the SCIM provider. \n\n**Note:** This API does not support filtering, pagination, or sorting.\n", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } } }, "response": [] }, { "name": "Get feature metadata", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}scim/directory/:directoryId/ServiceProviderConfig", "query": [], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "The SCIM base URL that is generated when [conecting an identity provider with SCIM provisioning](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/#Connect-an-identity-provider-with-SCIM-provisioning).", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get metadata about the supported SCIM features. This is a service provider configuration endpoint providing supported SCIM features. \n\n**Note:** This API does not support filtering, pagination, or sorting.\n", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } } }, "response": [] } ] }, { "name": "Service Provider Configuration", "item": [ { "name": "Get resource types", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}scim/directory/:directoryId/ResourceTypes", "query": [], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "The SCIM base URL that is generated when [conecting an identity provider with SCIM provisioning](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/#Connect-an-identity-provider-with-SCIM-provisioning).", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get different types of resources available on a SCIM service provider (e.g., Users and Groups). \n**Note:** This API does not support filtering, pagination, or sorting.\n", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } } }, "response": [] }, { "name": "Get user resource types", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}scim/directory/:directoryId/ResourceTypes/User", "query": [], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "The SCIM base URL that is generated when [conecting an identity provider with SCIM provisioning](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/#Connect-an-identity-provider-with-SCIM-provisioning).", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves user resource types from the SCIM service provider. \n\n**Note:** This API does not support filtering, pagination, or sorting.\n", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } } }, "response": [] }, { "name": "Get group resource types", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}scim/directory/:directoryId/ResourceTypes/Group", "query": [], "variable": [ { "key": "directoryId", "value": "{{directoryId}}", "description": "The SCIM base URL that is generated when [conecting an identity provider with SCIM provisioning](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/#Connect-an-identity-provider-with-SCIM-provisioning).", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves group resource type of this SCIM service provider. \n\n**Note:** This API does not support filtering, pagination, or sorting.\n", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } } }, "response": [] } ] }, { "name": "Admin APIs", "description": "These sets of APIs will require the organization API token rather than the SCIM directory token.", "item": [ { "name": "Delete user in SCIM DB", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/user-provisioning/v1/org/:orgId/user/:AAID/onlyDeleteUserInDB", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.", "disabled": false }, { "key": "AAID", "value": "{{AAID}}", "description": "Unique ID of the user's account.\nThe AAID can either be found in the URL of a user's profile, when browsing in the \"Users\" tab or the \"Managed Users\" tab or use the [Get Users API](https://developer.atlassian.com/cloud/admin/user-provisioning/rest/api-group-users/#api-scim-directory-directoryid-users-get) to get the AAID. \nThe URL could look like:\n\n```https://admin.atlassian.com/o/{orgId}/users/{aaId}```\n\n```https://admin.atlassian.com/o/{orgId}/members/{aaId}```\n\n```https://admin.atlassian.com/s/{siteId}/users/{aaId}```\n", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Delete a user in our SCIM DB with a Atlassian Account ID (AAID). This will apply to all directories in your organization matching that AAID and only works for managed users. \n\n\nYou will have to completely reprovision the user to their respective groups after deletion. \n\n\nExplore more about [updating managed SCIM email addresses](../../email-change/).\n", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } } }, "response": [] }, { "name": "Get SCIM links for an account", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/user-provisioning/v1/org/:orgId/user/:aaId/get-scim-links", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.", "disabled": false }, { "key": "aaId", "value": "{{aaId}}", "description": "Unique ID of the user's account.\nThe AAID can either be found in the URL of a user's profile, when browsing in the \"Users\" tab or the \"Managed Users\" tab or use the [Get Users API](https://developer.atlassian.com/cloud/admin/user-provisioning/rest/api-group-users/#api-scim-directory-directoryid-users-get) to get the AAID. \nThe URL could look like:\n\n```https://admin.atlassian.com/o/{orgId}/users/{aaId}```\n\n```https://admin.atlassian.com/o/{orgId}/members/{aaId}```\n\n```https://admin.atlassian.com/s/{siteId}/users/{aaId}```\n", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get SCIM Links for a Atlassian Account ID (AAID).", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } } }, "response": [] }, { "name": "Get SCIM Links for an email", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/user-provisioning/v1/org/:orgId/get-scim-links-for-email", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get SCIM Links for an email address in an organization.", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Unlink a SCIM user from their Atlassian account", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/user-provisioning/v1/org/:orgId/scimDirectoryId/:scimDirectoryId/scimUserId/:scimUserId/unlink", "query": [], "variable": [ { "key": "orgId", "value": "{{orgId}}", "description": "Your organization is identified by a Unique ID. You get your organization ID and Organization API key simultaneously.", "disabled": false }, { "key": "scimDirectoryId", "value": "{{scimDirectoryId}}", "description": "The SCIM base URL that is generated when [conecting an identity provider with SCIM provisioning](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/#Connect-an-identity-provider-with-SCIM-provisioning).", "disabled": false }, { "key": "scimUserId", "value": "{{scimUserId}}", "description": "The SCIM user ID to unlink. Use the [Get SCIM Links for an email API](https://developer.atlassian.com/cloud/admin/user-provisioning/rest/api-group-admin-apis/#api-admin-user-provisioning-v1-org-orgid-get-scim-links-for-email-post) to get the SCIM User ID.", "disabled": false } ] }, "method": "PATCH", "header": [], "description": "Unlinks a SCIM user from their Atlassian account without deleting the user.", "auth": { "type": "oauth2", "oauth2": { "accessTokenUrl": "https://api.atlassian.com/oauth/token", "addTokenTo": "header", "clientAuth": "body", "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}", "grantType": "client_credentials" } } }, "response": [] } ] } ], "variable": [ { "key": "protocol", "name": "Protocol", "description": "The HTTP Protocol that should be used for this REST API.", "type": "string", "value": "https" }, { "key": "host", "name": "Host", "description": "The HTTP host that should be used for this REST API.", "type": "string", "value": "api.atlassian.com" }, { "key": "basePath", "name": "Base Path", "description": "The path, after the host, of the base of the REST API.", "type": "string", "value": "" } ] }