Crowd 6.1.0

Welcome to the Crowd REST API reference. This page documents the REST resources available in Crowd, along with expected HTTP response codes and sample requests. This set of REST APIs is intended to be used by applications connecting to Crowd.

URI Structure

The Crowd REST APIs allow you to address the Crowd data entities as 'resources'. This means that the data entities are identified by URIs and operated on by HTTP requests (GET, POST, PUT and DELETE). Below are details of the resources made available by the APIs. To use a REST API, your application will make an HTTP request and parse the response.

Depending on the resource, responses are returned as JSON and/or XML. For resources that offer both, you can use the Accept HTTP header to specify which one you prefer. URIs for Crowd's REST API resource have the following structure:

http://host:port/context/rest/api-name/api-version/resource-name

The following API names are available in Crowd:

usermanagement - used by applications to interact with the Crowd server for user management operations
admin - used for administrative operations on the Crowd server
appmanagement - used for administrative operations on the Crowd server for application management

Each API has it's version. However, there is also a symbolic version, called latest, which resolves to the latest version supported by the given Crowd instance. As an example, if you wanted to retrieve information about a user 'admin' from a Crowd instance, you would access:

https://crowd-server:8095/crowd/rest/usermanagement/latest/user?username=admin

There is a WADL document that contains the documentation for each resource in the REST API. It is available here.

Authentication

The preferred authentication methods for the Crowd REST APIs is HTTP basic authentication (when using SSL).

Please note that the usermanagement resource expects the callers to authenticate using the application credentials (i.e. the application name and password configured in Crowd). Calls to this APIs are restricted by IP as configured. Permissions and seen users, groups and other entities depend on the application configuration as well.

Other resources expect the callers to authenticate using the user credentials. Permissions depend on configured user permissions.

Expansion

In order to simplify API responses, the Crowd REST API uses resource expansion. This means the API will only return parts of the resource when explicitly requested.

You can use the expand query parameter to specify a comma-separated list of entities that you want expanded, identifying each of them by name. For example, appending ?expand=attributes to a users's URI requests the inclusion of the user attribute names and values in the response. Continuing with our example above, we would use the following URL to get the attribute values for the 'admin' user:

https://crowd-server:8095/crowd/rest/usermanagement/latest/user?username=admin&expand=attributes

To discover the identifiers for each entity, look at the expand property in the parent object. In the JSON example below, the resource declares widgets as being expandable.

{"expand":"widgets", "widgets":{"widgets":[]}}

You can use the dot notation to specify expansion of entities within another entity. For example ?expand=widgets.fringels would expand the widgets collection and also the fringel property on each widget.

Pagination

Crowd uses pagination to limit the response size for resources that return a potentially large collection of items. A request to a paged API will result in a values array, wrapped in a JSON object with some paging metadata:

        {
            "values": [
                {
                    /* result 0 */
                },
                {
                    /* result 1 */
                },
                {
                    /* result 2 */
                }
            ],
            "size": 3,
            "start": 0,
            "limit": 50,
            "isLastPage": true
        }

Clients can use the limit and start query parameters to retrieve the desired number of results.

The limit parameter indicates how many results to return per page. Most APIs default to returning 50 if the limit is left unspecified. This number can be increased, but note that a resource-specific hard limit will apply. These hard limits can be configured by server administrators, so it's always best practice to check the limit attribute on the response to see what limit has been applied. The request to get a larger page should look like this:

    http://host:port/context/rest/api-name/api-version/path/to/resource?limit={desired size of page}

The start parameter indicates which item should be used as the first item in the page of results. All paged responses contain an isLastPage attribute indicating whether another page of items exists.

Experimental methods

Methods marked as experimental may change without an earlier notice. We are looking for your feedback for these methods.

Resources

admin/1.0/application

Get applications experimental`GET /rest/admin/1.0/application`

Request

query parameters

parameter	type	description
`name`	string
`active`	boolean

Responses

Status - application/json

Get application experimental`GET /rest/admin/1.0/application/{applicationId}`

Responses

Status - application/json

Update application experimental`PUT /rest/admin/1.0/application/{applicationId}`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/application-entity#","title":"Application Entity","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["CROWD","GENERIC_APPLICATION","PLUGIN","JIRA","CONFLUENCE","BAMBOO","FISHEYE","CRUCIBLE","STASH"]},"active":{"type":"boolean"},"aliasingEnabled":{"type":"boolean"},"lowercaseOutput":{"type":"boolean"},"aggregateMemberships":{"type":"boolean"},"cachedDirectoriesAuthenticationOrderOptimisation":{"type":"boolean"},"directoryMappings":{"title":"Directory Mappings Entity","type":"object","properties":{"mappings":{"type":"array","items":{"title":"Directory Mapping Entity","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"authentication":{"title":"Directory Mapping Authentication Entity","type":"object","properties":{"allowAll":{"type":"boolean"},"allowGroups":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"defaultGroups":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}},"additionalProperties":false},"filteringUsersWithAccessEnabled":{"type":"boolean"},"filteringGroupsWithAccessEnabled":{"type":"boolean"}},"additionalProperties":false}

Responses

Status - application/json

Get application access based synchronization filter experimental`GET /rest/admin/1.0/application/{applicationId}/access-based-synchronization`

Responses

Status - application/json

Update application access based synchronization filter experimental`PUT /rest/admin/1.0/application/{applicationId}/access-based-synchronization`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/access-based-synchronization-filter-type-entity#","title":"Access Based Synchronization Filter Type Entity","type":"object","properties":{"filterType":{"type":"string","enum":["NO_FILTERING","USER_ONLY_FILTERING","USER_AND_GROUP_FILTERING"]}},"additionalProperties":false}

Responses

Status - application/json

Get application directory mappings experimental`GET /rest/admin/1.0/application/{applicationId}/directory-mapping`

Responses

Status - application/json

Add application directory mapping experimental`POST /rest/admin/1.0/application/{applicationId}/directory-mapping`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/directory-mapping-entity#","title":"Directory Mapping Entity","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"authentication":{"title":"Directory Mapping Authentication Entity","type":"object","properties":{"allowAll":{"type":"boolean"},"allowGroups":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"defaultGroups":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}

Responses

Status - application/json

Delete application directory mapping experimental`DELETE /rest/admin/1.0/application/{applicationId}/directory-mapping/{directoryId}`

Responses

Status - application/json

Get application directory mapping experimental`GET /rest/admin/1.0/application/{applicationId}/directory-mapping/{directoryId}`

Responses

Status - application/json

Update application directory mapping experimental`PUT /rest/admin/1.0/application/{applicationId}/directory-mapping/{directoryId}`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/directory-mapping-entity#","title":"Directory Mapping Entity","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"authentication":{"title":"Directory Mapping Authentication Entity","type":"object","properties":{"allowAll":{"type":"boolean"},"allowGroups":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"defaultGroups":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}

Responses

Status - application/json

Reorder application directory mapping experimental`POST /rest/admin/1.0/application/{applicationId}/directory-mapping/{directoryId}/move`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/reorder-entity#","title":"Reorder Entity","type":"object","properties":{"after":{"type":"string"},"position":{"type":"string"}},"additionalProperties":false}

Responses

Status - application/json

Get latest scan result`GET /rest/admin/1.0/application/{applicationId}/emailscan`

Responses

Status - application/json

Trigger email scan`POST /rest/admin/1.0/application/{applicationId}/emailscan`

Responses

Status - application/json

admin/1.0/auditlog

Add changeset`POST /rest/admin/1.0/auditlog`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/audit-log-changeset-rest#","title":"Audit Log Changeset Rest","type":"object","properties":{"id":{"type":"integer"},"timestamp":{"type":"string"},"author":{"title":"Audit Log Author Rest","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"displayName":{"type":"string"},"originalName":{"type":"string"},"type":{"type":"string","enum":["USER","APPLICATION","SYSTEM","PLUGIN","SYNCHRONIZATION","DATA_IMPORT","OTHER"]},"subtype":{"type":"string"}},"additionalProperties":false},"authorType":{"type":"string","enum":["USER","APPLICATION","SYSTEM","PLUGIN","SYNCHRONIZATION","DATA_IMPORT","OTHER"]},"authorId":{"type":"integer"},"authorName":{"type":"string"},"eventType":{"type":"string","enum":["CREATED","MODIFIED","DELETED","STARTED","COMPLETED","FAILED","OTHER","APPLICATION_CREATED","APPLICATION_UPDATED","APPLICATION_DELETED","DIRECTORY_CREATED","DIRECTORY_UPDATED","DIRECTORY_DELETED","CONFIGURATION_MODIFIED","BACKUP_STARTED","BACKUP_FINISHED","RESTORE_STARTED","RESTORE_FINISHED","USER_CREATED","USER_UPDATED","USER_DELETED","GROUP_CREATED","GROUP_UPDATED","GROUP_DELETED","ADDED_TO_GROUP","REMOVED_FROM_GROUP","ALIAS_CREATED","ALIAS_UPDATED","ALIAS_DELETED","SYNCHRONIZATION_STARTED","SYNCHRONIZATION_FINISHED","IMPORT_STARTED","IMPORT_FINISHED","PASSWORD_RESET_STARTED","PASSWORD_RESET_FINISHED","PASSWORD_CHANGED","GROUP_ADMIN_ASSIGNED","GROUP_ADMIN_REVOKED"]},"entityType":{"type":"string","enum":["APPLICATION","DIRECTORY","USER","GROUP","CONFIGURATION","RESTORE","OTHER"]},"entityId":{"type":"integer"},"entityName":{"type":"string"},"entities":{"type":"array","items":{"title":"Audit Log Entity Rest","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"displayName":{"type":"string"},"originalName":{"type":"string"},"type":{"type":"string","enum":["APPLICATION","DIRECTORY","USER","GROUP","CONFIGURATION","RESTORE","OTHER"]},"subtype":{"type":"string"},"primary":{"type":"boolean"}},"additionalProperties":false}},"ipAddress":{"type":"string"},"eventMessage":{"type":"string"},"source":{"type":"string","enum":["MANUAL","SYNCHRONIZATION","DATA_IMPORT"]},"entries":{"type":"array","items":{"title":"Audit Log Entry Rest","type":"object","properties":{"propertyName":{"type":"string"},"oldValue":{"type":"string"},"newValue":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false}

Responses

Status - application/json

Get configuration`GET /rest/admin/1.0/auditlog/configuration`

Responses

Status - application/json

Set configuration`PUT /rest/admin/1.0/auditlog/configuration`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/audit-log-configuration-entity#","title":"Audit Log Configuration Entity","type":"object","properties":{"retentionPeriod":{"type":"string","enum":["ONE_MONTH","THREE_MONTHS","SIX_MONTHS","UNLIMITED"]}},"additionalProperties":false}

Responses

Status - application/json

Search audit log experimental`POST /rest/admin/1.0/auditlog/query`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/audit-log-query-rest#","title":"Audit Log Query Rest","type":"object","properties":{"onOrAfter":{"type":"string"},"beforeOrOn":{"type":"string"},"actions":{"type":"array","items":{"type":"string","enum":["CREATED","MODIFIED","DELETED","STARTED","COMPLETED","FAILED","OTHER","APPLICATION_CREATED","APPLICATION_UPDATED","APPLICATION_DELETED","DIRECTORY_CREATED","DIRECTORY_UPDATED","DIRECTORY_DELETED","CONFIGURATION_MODIFIED","BACKUP_STARTED","BACKUP_FINISHED","RESTORE_STARTED","RESTORE_FINISHED","USER_CREATED","USER_UPDATED","USER_DELETED","GROUP_CREATED","GROUP_UPDATED","GROUP_DELETED","ADDED_TO_GROUP","REMOVED_FROM_GROUP","ALIAS_CREATED","ALIAS_UPDATED","ALIAS_DELETED","SYNCHRONIZATION_STARTED","SYNCHRONIZATION_FINISHED","IMPORT_STARTED","IMPORT_FINISHED","PASSWORD_RESET_STARTED","PASSWORD_RESET_FINISHED","PASSWORD_CHANGED","GROUP_ADMIN_ASSIGNED","GROUP_ADMIN_REVOKED"]}},"sources":{"type":"array","items":{"type":"string","enum":["MANUAL","SYNCHRONIZATION","DATA_IMPORT"]}},"authors":{"type":"array","items":{"title":"Audit Log Author Restriction Rest","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string","enum":["USER","APPLICATION","SYSTEM","PLUGIN","SYNCHRONIZATION","DATA_IMPORT","OTHER"]}},"additionalProperties":false}},"users":{"type":"array","items":{"$ref":"#/definitions/audit-log-entity-restriction-rest"}},"groups":{"type":"array","items":{"$ref":"#/definitions/audit-log-entity-restriction-rest"}},"applications":{"type":"array","items":{"$ref":"#/definitions/audit-log-entity-restriction-rest"}},"directories":{"type":"array","items":{"$ref":"#/definitions/audit-log-entity-restriction-rest"}}},"definitions":{"audit-log-entity-restriction-rest":{"title":"Audit Log Entity Restriction Rest","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

Responses

Status - application/json

Get filter values experimental`POST /rest/admin/1.0/auditlog/query/filter`

Request

query parameters

parameter	type	description
`search`	string
`projection`	string

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/audit-log-query-rest#","title":"Audit Log Query Rest","type":"object","properties":{"onOrAfter":{"type":"string"},"beforeOrOn":{"type":"string"},"actions":{"type":"array","items":{"type":"string","enum":["CREATED","MODIFIED","DELETED","STARTED","COMPLETED","FAILED","OTHER","APPLICATION_CREATED","APPLICATION_UPDATED","APPLICATION_DELETED","DIRECTORY_CREATED","DIRECTORY_UPDATED","DIRECTORY_DELETED","CONFIGURATION_MODIFIED","BACKUP_STARTED","BACKUP_FINISHED","RESTORE_STARTED","RESTORE_FINISHED","USER_CREATED","USER_UPDATED","USER_DELETED","GROUP_CREATED","GROUP_UPDATED","GROUP_DELETED","ADDED_TO_GROUP","REMOVED_FROM_GROUP","ALIAS_CREATED","ALIAS_UPDATED","ALIAS_DELETED","SYNCHRONIZATION_STARTED","SYNCHRONIZATION_FINISHED","IMPORT_STARTED","IMPORT_FINISHED","PASSWORD_RESET_STARTED","PASSWORD_RESET_FINISHED","PASSWORD_CHANGED","GROUP_ADMIN_ASSIGNED","GROUP_ADMIN_REVOKED"]}},"sources":{"type":"array","items":{"type":"string","enum":["MANUAL","SYNCHRONIZATION","DATA_IMPORT"]}},"authors":{"type":"array","items":{"title":"Audit Log Author Restriction Rest","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string","enum":["USER","APPLICATION","SYSTEM","PLUGIN","SYNCHRONIZATION","DATA_IMPORT","OTHER"]}},"additionalProperties":false}},"users":{"type":"array","items":{"$ref":"#/definitions/audit-log-entity-restriction-rest"}},"groups":{"type":"array","items":{"$ref":"#/definitions/audit-log-entity-restriction-rest"}},"applications":{"type":"array","items":{"$ref":"#/definitions/audit-log-entity-restriction-rest"}},"directories":{"type":"array","items":{"$ref":"#/definitions/audit-log-entity-restriction-rest"}}},"definitions":{"audit-log-entity-restriction-rest":{"title":"Audit Log Entity Restriction Rest","type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

Responses

Status - application/json

admin/1.0/backup

Create backup`POST /rest/admin/1.0/backup`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/file-name-entity#","title":"File Name Entity","type":"object","properties":{"fileName":{"type":"string"}},"additionalProperties":false}

Responses

Status - application/json

Get backup configuration`GET /rest/admin/1.0/backup/configuration`

Responses

Status - application/json

Save backup configuration`POST /rest/admin/1.0/backup/configuration`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/backup-configuration-entity#","title":"Backup Configuration Entity","type":"object","properties":{"dailyBackupTime":{"type":"string"},"resetDomainEnabled":{"type":"boolean"},"backupConnectorEnabled":{"type":"boolean"},"scheduledBackupEnabled":{"type":"boolean"}},"additionalProperties":false}

Responses

Status - application/json

Get backup information`GET /rest/admin/1.0/backup/summary`

Responses

Status - application/json

admin/1.0/directory

Get detailed directories experimental`GET /rest/admin/1.0/directory/detailed`

Request

query parameters

parameter	type	description
`search`	string
`active`	boolean

Responses

Status - application/json

Get detailed directory experimental`GET /rest/admin/1.0/directory/detailed/{directoryId}`

Responses

Status - application/json

Schedule synchronization experimental`POST /rest/admin/1.0/directory/detailed/{directoryId}/synchronize`

Responses

Status - application/json

Get managed directories experimental`GET /rest/admin/1.0/directory/managed`

Responses

Status - application/json

admin/1.0/dismiss

Dismiss message`POST /rest/admin/1.0/dismiss/{messageKey}`

Responses

Status - application/json

admin/1.0/encryption

Get encryption settings experimental`GET /rest/admin/1.0/encryption`

Responses

Status - application/json

Change key experimental`PUT /rest/admin/1.0/encryption/changeKey`

Responses

Status - application/json

Disable encryption experimental`PUT /rest/admin/1.0/encryption/disable`

Responses

Status - application/json

Set default encryptor experimental`PUT /rest/admin/1.0/encryption/encryptor`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/string#","title":"String","type":"string"}

Responses

Status - application/json

admin/1.0/group

Get nested groups experimental`GET /rest/admin/1.0/group/{groupId}/groups`

Responses

Status - application/json

Add groups to group experimental`POST /rest/admin/1.0/group/{groupId}/groups`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/group-identifiers-entity-list#","title":"Group Identifiers Entity List","type":"object","properties":{"groupIdentifiers":{"type":"array","items":{"title":"Directory Entity Id","type":"object"}}},"additionalProperties":false}

Responses

Status - application/json

Search directory groups experimental`GET /rest/admin/1.0/group/search/{directoryId}`

Request

query parameters

parameter	type	description
`term`	string
`active`	boolean

Responses

Status - application/json

admin/1.0/group-level-admin

Get group administrators`GET /rest/admin/1.0/group-level-admin/{groupId}/admins`

Responses

Status - application/json

Add group administrators experimental`POST /rest/admin/1.0/group-level-admin/{groupId}/admins`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/list-of-directory-entity-rest#","title":"List of Directory Entity Rest","type":"array","items":{"title":"Directory Entity Rest","type":"object","properties":{"id":{"title":"Directory Entity Id","type":"object"},"type":{"type":"string","enum":["USER","GROUP"]}},"additionalProperties":false}}

Responses

Status - application/json

Delete group group administrator experimental`DELETE /rest/admin/1.0/group-level-admin/{groupId}/admins/groups/{adminId}`

Responses

Status - application/json

Get admin candidates`GET /rest/admin/1.0/group-level-admin/{groupId}/admins/suggestions`

Request

query parameters

parameter	type	description
`search`	string
`limit`	int Default: `100`

Responses

Status - application/json

Delete user group administrator experimental`DELETE /rest/admin/1.0/group-level-admin/{groupId}/admins/users/{adminId}`

Responses

Status - application/json

admin/1.0/groups

Group details`GET /rest/admin/1.0/groups/{groupId}`

Responses

Status - application/json

Remove users from group`DELETE /rest/admin/1.0/groups/{groupId}/users`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/user-identifiers-entity-list#","title":"User Identifiers Entity List","type":"object","properties":{"userIdentifiers":{"type":"array","items":{"title":"Directory Entity Id","type":"object"}}},"additionalProperties":false}

Responses

Status - application/json

Group members`GET /rest/admin/1.0/groups/{groupId}/users`

Responses

Status - application/json

Add users to group`POST /rest/admin/1.0/groups/{groupId}/users`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/user-identifiers-entity-list#","title":"User Identifiers Entity List","type":"object","properties":{"userIdentifiers":{"type":"array","items":{"title":"Directory Entity Id","type":"object"}}},"additionalProperties":false}

Responses

Status - application/json

Search users`GET /rest/admin/1.0/groups/{groupId}/users/suggestions`

Request

query parameters

parameter	type	description
`search`	string
`limit`	int Default: `100`

Responses

Status - application/json

Search administered groups experimental`POST /rest/admin/1.0/groups/query`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/groups-filter#","title":"Groups Filter","type":"object","properties":{"search":{"type":"string"},"directoryId":{"type":"integer"}},"additionalProperties":false}

Responses

Status - application/json

admin/1.0/licensing

List directories experimental`GET /rest/admin/1.0/licensing/{applicationId}/directories`

Request

query parameters

parameter	type	description
`version`	long
`jiraType`	string

Responses

Status - application/json

List jira types experimental`GET /rest/admin/1.0/licensing/{applicationId}/jira-types`

Request

query parameters

parameter	type	description
`version`	long

Responses

Status - application/json

Export licensed users experimental`GET /rest/admin/1.0/licensing/{applicationId}/licensed-users/download`

Request

query parameters

parameter	type	description
`search`	string
`directoryId`	string
`jiraType`	string
`lastLoginBefore`	long
`searchVersion`	long

Responses

Status - text/csv

Search licensed users experimental`POST /rest/admin/1.0/licensing/{applicationId}/licensed-users/search`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/licensed-user-search-parameters#","title":"Licensed User Search Parameters","type":"object","properties":{"search":{"type":"string"},"directoryId":{"type":"string"},"jiraType":{"type":"string"},"lastLoginBefore":{"type":"integer"},"searchVersion":{"type":"integer"}},"additionalProperties":false}

Responses

Status - application/json

Get licensing summary experimental`GET /rest/admin/1.0/licensing/{applicationId}/summary`

Request

query parameters

parameter	type	description
`version`	long
`jiraType`	string

Responses

Status - application/json

admin/1.0/look-and-feel

Get config`GET /rest/admin/1.0/look-and-feel/config`

Responses

Status - application/json

Update config`PUT /rest/admin/1.0/look-and-feel/config`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/look-and-feel-config-entity#","title":"Look And Feel Config Entity","type":"object","properties":{"showLogo":{"type":"boolean"},"logo":{"type":"string"},"customLogoId":{"type":"string"},"header":{"type":"string"},"welcomeText":{"type":"string"},"primaryColor":{"type":"string"},"showAnnouncement":{"type":"boolean"},"announcementText":{"type":"string"}},"additionalProperties":false}

Responses

Status - application/json

Remove configuration`POST /rest/admin/1.0/look-and-feel/reset-config`

Responses

Status - application/json

admin/1.0/mail/configuration

Save configuration`POST /rest/admin/1.0/mail/configuration`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/mail-server-configuration-entity#","title":"Mail Server Configuration Entity","type":"object","properties":{"from":{"type":"string"},"notificationEmails":{"type":"array","items":{"type":"string"}},"prefix":{"type":"string"},"host":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"jndiLocation":{"type":"string"},"port":{"type":"integer"},"jndiMailActive":{"type":"boolean"},"useSSL":{"type":"string"},"addressToTest":{"type":"string"},"timeout":{"type":"integer"},"startTLS":{"type":"string"}},"additionalProperties":false}

Responses

Status - application/json

Test mail server connection`POST /rest/admin/1.0/mail/configuration/test`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/mail-server-configuration-entity#","title":"Mail Server Configuration Entity","type":"object","properties":{"from":{"type":"string"},"notificationEmails":{"type":"array","items":{"type":"string"}},"prefix":{"type":"string"},"host":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"jndiLocation":{"type":"string"},"port":{"type":"integer"},"jndiMailActive":{"type":"boolean"},"useSSL":{"type":"string"},"addressToTest":{"type":"string"},"timeout":{"type":"integer"},"startTLS":{"type":"string"}},"additionalProperties":false}

Responses

Status - application/json

Validate fields`POST /rest/admin/1.0/mail/configuration/validate`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/mail-server-configuration-entity#","title":"Mail Server Configuration Entity","type":"object","properties":{"from":{"type":"string"},"notificationEmails":{"type":"array","items":{"type":"string"}},"prefix":{"type":"string"},"host":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"jndiLocation":{"type":"string"},"port":{"type":"integer"},"jndiMailActive":{"type":"boolean"},"useSSL":{"type":"string"},"addressToTest":{"type":"string"},"timeout":{"type":"integer"},"startTLS":{"type":"string"}},"additionalProperties":false}

Responses

Status - application/json

admin/1.0/remember-me

Get configuration`GET /rest/admin/1.0/remember-me/config`

Responses

Status - application/json

Save configuration`PUT /rest/admin/1.0/remember-me/config`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/remember-me-configuration-entity#","title":"Remember Me Configuration Entity","type":"object","properties":{"expirationPeriod":{"type":"integer"},"enabled":{"type":"boolean"}},"additionalProperties":false}

Responses

Status - application/json

Expire all tokens`POST /rest/admin/1.0/remember-me/expire-all`

Responses

Status - application/json

admin/1.0/samlconfig

Get saml configuration`GET /rest/admin/1.0/samlconfig`

Responses

Status - application/json

Get idp metadata`GET /rest/admin/1.0/samlconfig/idp/metadata`

Responses

Status - application/json

Reset saml configuration`POST /rest/admin/1.0/samlconfig/reset-certificates`

Responses

Status - application/json

Get configuration`GET /rest/admin/1.0/samlconfig/application/{applicationId}`

Responses

Status - application/json

Update application configuration`POST /rest/admin/1.0/samlconfig/application/{applicationId}`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/application-saml-configuration-rest-entity#","title":"Application Saml Configuration Rest Entity","type":"object","properties":{"entityId":{"type":"string"},"assertionConsumerUrl":{"type":"string"},"enabled":{"type":"boolean"},"nameIdFormat":{"type":"string","enum":["UNSPECIFIED","EMAIL"]},"addUserAttributesEnabled":{"type":"boolean"}},"additionalProperties":false,"required":["addUserAttributesEnabled"]}

Responses

Status - application/json

Find directory mappings mismatch`GET /rest/admin/1.0/samlconfig/application/{applicationId}/directory-mapping-mismatch`

Responses

Status - application/json

Parse application metadata`POST /rest/admin/1.0/samlconfig/application/parse_metadata`

Request

Responses

Status - application/json

Parse application metadata`POST /rest/admin/1.0/samlconfig/application/parse_metadata_multipart`

Responses

Status - application/json

admin/1.0/server-info

Get server info`GET /rest/admin/1.0/server-info`

Responses

Status - application/json

admin/1.0/sessions

Expire session experimental`DELETE /rest/admin/1.0/sessions/{randomHash}`

Responses

Status - application/json

Get application sessions experimental`GET /rest/admin/1.0/sessions/application`

Request

query parameters

parameter	type	description
`search`	string

Responses

Status - application/json

Get user sessions experimental`GET /rest/admin/1.0/sessions/user`

Request

query parameters

parameter	type	description
`search`	string
`directoryId`	long

Responses

Status - application/json

admin/1.0/spring-ldap-pool-statistics

Get dynamic ldap pools statistics`GET /rest/admin/1.0/spring-ldap-pool-statistics`

Responses

Status - application/json

admin/1.0/users

Remove user from groups`DELETE /rest/admin/1.0/users/{userId}/groups`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/group-identifiers-entity-list#","title":"Group Identifiers Entity List","type":"object","properties":{"groupIdentifiers":{"type":"array","items":{"title":"Directory Entity Id","type":"object"}}},"additionalProperties":false}

Responses

Status - application/json

Add user to groups`POST /rest/admin/1.0/users/{userId}/groups`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/group-identifiers-entity-list#","title":"Group Identifiers Entity List","type":"object","properties":{"groupIdentifiers":{"type":"array","items":{"title":"Directory Entity Id","type":"object"}}},"additionalProperties":false}

Responses

Status - application/json

Search users`POST /rest/admin/1.0/users/search`

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/user-search-params#","title":"User Search Params","type":"object","properties":{"search":{"type":"string"},"directoryIds":{"type":"array","items":{"type":"integer"}},"active":{"type":"boolean"},"avatarSizeHint":{"type":"integer"}},"additionalProperties":false,"required":["avatarSizeHint"]}

Responses

Status - application/json

appmanagement/1/aliases

Resource for managing aliases.

Delete all aliases for user`DELETE /rest/appmanagement/1/aliases`

Removes all aliases of the specified user from all applications, even from applications where aliasing is disabled.

Request

query parameters

parameter	type	description
`user`	string	username in Crowd (does not need to exist)

Responses

Status 204
Aliases have been removed

Status 409
Returned when the username is already in use by another user as their alias in at least one of the applications

Get all aliases for user as json`GET /rest/appmanagement/1/aliases`

Returns all aliases of the specified user from all alias-enabled applications.

Request

query parameters

parameter	type	description
`user`	string	username in Crowd (does not need to exist)

Responses

Status 200

Returns all aliases of the specified user

Schema

{"type":"object","patternProperties":{".+":{"type":"string"}},"additionalProperties":false}

Set all aliases for user`PUT /rest/appmanagement/1/aliases`

Sets the alias for the given username in all the applications, replacing the previous alias set for the same username, if they exist. Applications that are not included in the map will have their aliases removed.

Request

query parameters

parameter	type	description
`user`	string	username in Crowd (does not need to exist)

Example

{"applicationid-1":"Alias-1","applicationid-3":"Alias-3"}

Schema

{"type":"object","patternProperties":{".+":{"type":"string"}},"additionalProperties":false}

Responses

Status 204
Aliases have been updated

Status 409
Returned when some of the aliases cannot be inserted

Delete alias`DELETE /rest/appmanagement/1/aliases/{applicationId}/alias`

Removes user's alias in a specified application.

Request

query parameters

parameter	type	description
`user`	string	username in Crowd (does not need to exist)

Responses

Status 204
Alias has been removed

Status 404
Returned when Application not found

Status 409
Returned when the username is already in use by another user as their alias in the specified application

Get alias`GET /rest/appmanagement/1/aliases/{applicationId}/alias`

Returns the user's alias in the specified application.

Request

query parameters

parameter	type	description
`user`	string	username in Crowd

Responses

Status 200

Returns the alias

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/string#","title":"String","type":"string"}

Status 404
Returned when Application not found or User not found

Set alias`PUT /rest/appmanagement/1/aliases/{applicationId}/alias`

Sets the user's alias in the specified application.

Request

query parameters

parameter	type	description
`user`	string	username in Crowd

Responses

Status 204
Alias has been updated

Status 404
Returned when Application not found

Status 409
Returned when Alias is already in use

Get username for alias`GET /rest/appmanagement/1/aliases/{applicationId}/username`

Returns user's username in a specified application.

Request

query parameters

parameter	type	description
`alias`	string	user's alias

Responses

Status 200
Returns the username behind the alias (if exists)
Schema
```
{"id":"https://docs.atlassian.com/jira/REST/schema/string#","title":"String","type":"string"}
```

Status 404
Returned when Application not found

appmanagement/1/application

Represents an Application resource.

Get applications`GET /rest/appmanagement/1/application`

Returns all the applications or a specific application by name

Request

query parameters

parameter	type	description
`name`	string

Responses

Status - application/xml
Status - application/json

Add application`POST /rest/appmanagement/1/application`

Adds a new application.

Request

query parameters

parameter	type	description
`include-request-address`	boolean Default: `false`

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/application-entity#","title":"Application Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string"},"description":{"type":"string"},"active":{"type":"boolean"},"attributes":{"title":"Attribute Entity List","type":"object","properties":{"attributes":{"type":"array","items":{"title":"Attribute Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"name":{"type":"string"},"value":{"type":"string"}},"additionalProperties":false}},"link":{"$ref":"#/definitions/link"}},"additionalProperties":false},"password":{"title":"Password Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"value":{"type":"string"}},"additionalProperties":false},"directory-mappings":{"title":"Directory Mapping Entity List","type":"object","properties":{"directoryMappings":{"type":"array","items":{"title":"Directory Mapping Entity","type":"object","properties":{"id":{"type":"integer"},"authenticate-all":{"type":"boolean"},"allowedOperations":{"type":"array","items":{"type":"string"}},"link":{"$ref":"#/definitions/link"}},"additionalProperties":false}},"link":{"$ref":"#/definitions/link"}},"additionalProperties":false},"remote-addresses":{"title":"Remote Address Entity Set","type":"object","properties":{"remoteAddresses":{"type":"array","items":{"title":"Remote Address Entity","type":"object","properties":{"value":{"type":"string"},"link":{"$ref":"#/definitions/link"}},"additionalProperties":false}},"link":{"$ref":"#/definitions/link"}},"additionalProperties":false},"lowercase-output":{"type":"boolean"},"aliasing-enabled":{"type":"boolean"}},"definitions":{"link":{"title":"Link","type":"object","properties":{"href":{"type":"string","format":"uri"},"type":{"type":"string"},"rel":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

Responses

Status - application/xml
Status - application/json

Remove application`DELETE /rest/appmanagement/1/application/{applicationId}`

Removes the specified application.

Responses

Status - application/xml
Status - application/json

Get application by id`GET /rest/appmanagement/1/application/{applicationId}`

Returns the specified application.

Responses

Status - application/xml
Status - application/json

Update application`PUT /rest/appmanagement/1/application/{applicationId}`

Updates the specified application.

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/application-entity#","title":"Application Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string"},"description":{"type":"string"},"active":{"type":"boolean"},"attributes":{"title":"Attribute Entity List","type":"object","properties":{"attributes":{"type":"array","items":{"title":"Attribute Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"name":{"type":"string"},"value":{"type":"string"}},"additionalProperties":false}},"link":{"$ref":"#/definitions/link"}},"additionalProperties":false},"password":{"title":"Password Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"value":{"type":"string"}},"additionalProperties":false},"directory-mappings":{"title":"Directory Mapping Entity List","type":"object","properties":{"directoryMappings":{"type":"array","items":{"title":"Directory Mapping Entity","type":"object","properties":{"id":{"type":"integer"},"authenticate-all":{"type":"boolean"},"allowedOperations":{"type":"array","items":{"type":"string"}},"link":{"$ref":"#/definitions/link"}},"additionalProperties":false}},"link":{"$ref":"#/definitions/link"}},"additionalProperties":false},"remote-addresses":{"title":"Remote Address Entity Set","type":"object","properties":{"remoteAddresses":{"type":"array","items":{"title":"Remote Address Entity","type":"object","properties":{"value":{"type":"string"},"link":{"$ref":"#/definitions/link"}},"additionalProperties":false}},"link":{"$ref":"#/definitions/link"}},"additionalProperties":false},"lowercase-output":{"type":"boolean"},"aliasing-enabled":{"type":"boolean"}},"definitions":{"link":{"title":"Link","type":"object","properties":{"href":{"type":"string","format":"uri"},"type":{"type":"string"},"rel":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

Responses

Status - application/xml
Status - application/json

Remove remote address`DELETE /rest/appmanagement/1/application/{applicationId}/remote_address`

Removes the remote address of the specified application.

Request

query parameters

parameter	type	description
`address`	string	remote address to remove

Responses

Status - application/xml
Status - application/json

Get remote addresses`GET /rest/appmanagement/1/application/{applicationId}/remote_address`

Returns the remote addresses of the specified application.

Responses

Status - application/xml
Status - application/json

Add remote address`POST /rest/appmanagement/1/application/{applicationId}/remote_address`

Adds the remote address to the specified application.

Request

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/remote-address-entity#","title":"Remote Address Entity","type":"object","properties":{"value":{"type":"string"},"link":{"title":"Link","type":"object","properties":{"href":{"type":"string","format":"uri"},"type":{"type":"string"},"rel":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

Responses

Status - application/xml
Status - application/json

directorymanagement/1/directory

Represents an Directory management resource.

Test azure ad connection`POST /rest/directorymanagement/1/directory/testazuread`

Tests connection to the specified Microsoft Entra ID.

Request

Example

{"tenantId":"example.onmicrosoft.com","webAppId":"1a23b45c-de67-8ce0-881c-b43acfee0x34","webAppSecret":"X70mv+pzvXoiib3OYwaRPVmzoFgq1eDpYUnGm0JTfzQ=","nativeAppId":"a1af321g-j123-4ter-84x2-a456d3987aa1","graphEndpoint":"https://graph.microsoft.com","authorityEndpoint":"https://login.windows.net","region":"GERMANY"}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/azure-ad-connection-test-entity#","title":"Azure Ad Connection Test Entity","type":"object","properties":{"tenantId":{"type":"string"},"webAppId":{"type":"string"},"webAppSecret":{"type":"string"},"nativeAppId":{"type":"string"},"graphEndpoint":{"type":"string"},"authorityEndpoint":{"type":"string"},"region":{"type":"string"}},"additionalProperties":false}

Responses

Status 400
Returned if the entity contains invalid values for fields

Status 204
Returned if the connection was successfully made

Status 409
Returned if there was a problem with connecting to the Microsoft Entra ID

Test azure ad connection`POST /rest/directorymanagement/1/directory/testazuread/{id}`

Tests connection to the specified Microsoft Entra ID.

Request

Example

{"tenantId":"example.onmicrosoft.com","webAppId":"1a23b45c-de67-8ce0-881c-b43acfee0x34","webAppSecret":"X70mv+pzvXoiib3OYwaRPVmzoFgq1eDpYUnGm0JTfzQ=","nativeAppId":"a1af321g-j123-4ter-84x2-a456d3987aa1","graphEndpoint":"https://graph.microsoft.com","authorityEndpoint":"https://login.windows.net","region":"GERMANY"}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/azure-ad-connection-test-entity#","title":"Azure Ad Connection Test Entity","type":"object","properties":{"tenantId":{"type":"string"},"webAppId":{"type":"string"},"webAppSecret":{"type":"string"},"nativeAppId":{"type":"string"},"graphEndpoint":{"type":"string"},"authorityEndpoint":{"type":"string"},"region":{"type":"string"}},"additionalProperties":false}

Responses

Status 400
Returned if the entity contains invalid values for fields

Status 204
Returned if the connection was successfully made

Status 409
Returned if there was a problem with connecting to the Microsoft Entra ID

Test crowd connection`POST /rest/directorymanagement/1/directory/testcrowd`

Tests connection to the specified Remote Crowd directory

Request

Example

{"url":"http://127.0.0.1:8095/crowd","applicationName":"application","applicationPassword":"application_password","httpProxyHost":"","httpProxyUsername":"","httpProxyPassword":""}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/crowd-connection-test-entity#","title":"Crowd Connection Test Entity","type":"object","properties":{"url":{"type":"string"},"applicationName":{"type":"string"},"applicationPassword":{"type":"string"},"httpProxyHost":{"type":"string"},"httpProxyPort":{"type":"integer"},"httpProxyUsername":{"type":"string"},"httpProxyPassword":{"type":"string"}},"additionalProperties":false}

Responses

Status 400
Returned if the entity contains invalid values for fields

Status 204
Returned if the connection was successfully made

Status 409
Returned if there was a problem with connecting to the Remote Crowd directory

Test crowd connection`POST /rest/directorymanagement/1/directory/testcrowd/{id}`

Tests connection to the specified Remote Crowd directory

Request

Example

{"url":"http://127.0.0.1:8095/crowd","applicationName":"application","applicationPassword":"application_password","httpProxyHost":"","httpProxyUsername":"","httpProxyPassword":""}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/crowd-connection-test-entity#","title":"Crowd Connection Test Entity","type":"object","properties":{"url":{"type":"string"},"applicationName":{"type":"string"},"applicationPassword":{"type":"string"},"httpProxyHost":{"type":"string"},"httpProxyPort":{"type":"integer"},"httpProxyUsername":{"type":"string"},"httpProxyPassword":{"type":"string"}},"additionalProperties":false}

Responses

Status 400
Returned if the entity contains invalid values for fields

Status 204
Returned if the connection was successfully made

Status 409
Returned if there was a problem with connecting to the Remote Crowd directory

Test ldap connection`POST /rest/directorymanagement/1/directory/testldap`

Tests connection to the specified LDAP server.

Request

Example

{"url":"ldap://localhost:389/","secureMode":"false","baseDN":"dc=test,dc=com","ldapPassword":"admin","userDN":"cn=admin,dc=test,dc=com","connector":"com.atlassian.crowd.directory.OpenLDAP","referral":false}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/ldap-connection-test-entity#","title":"Ldap Connection Test Entity","type":"object","properties":{"url":{"type":"string"},"secureMode":{"type":"string","enum":["false","true","starttls"]},"baseDN":{"type":"string"},"ldapPassword":{"type":"string"},"userDN":{"type":"string"},"connector":{"type":"string"},"referral":{"type":"boolean"},"userEncryptionMethod":{"type":"string"},"groupDNaddition":{"type":"string"},"groupDescriptionAttr":{"type":"string"},"groupMemberAttr":{"type":"string"},"groupNameAttr":{"type":"string"},"groupObjectClass":{"type":"string"},"groupObjectFilter":{"type":"string"},"userDNaddition":{"type":"string"},"userObjectClass":{"type":"string"},"userGroupMemberAttr":{"type":"string"},"userFirstnameAttr":{"type":"string"},"userLastnameAttr":{"type":"string"},"userDisplayNameAttr":{"type":"string"},"userMailAttr":{"type":"string"},"userNameAttr":{"type":"string"},"userNameRdnAttr":{"type":"string"},"userPasswordAttr":{"type":"string"},"userObjectFilter":{"type":"string"},"userExternalIdAttr":{"type":"string"}},"additionalProperties":false,"required":["referral"]}

Responses

Status 400
Returned if the entity contains invalid values for fields

Status 204
Returned if the connection was successfully made

Status 409
Returned if there was a problem with connecting to the LDAP server

Test ldap connection`POST /rest/directorymanagement/1/directory/testldap/{id}`

Tests connection to the specified LDAP server.

Request

Example

{"url":"ldap://localhost:389/","secureMode":"false","baseDN":"dc=test,dc=com","ldapPassword":"admin","userDN":"cn=admin,dc=test,dc=com","connector":"com.atlassian.crowd.directory.OpenLDAP","referral":false}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/ldap-connection-test-entity#","title":"Ldap Connection Test Entity","type":"object","properties":{"url":{"type":"string"},"secureMode":{"type":"string","enum":["false","true","starttls"]},"baseDN":{"type":"string"},"ldapPassword":{"type":"string"},"userDN":{"type":"string"},"connector":{"type":"string"},"referral":{"type":"boolean"},"userEncryptionMethod":{"type":"string"},"groupDNaddition":{"type":"string"},"groupDescriptionAttr":{"type":"string"},"groupMemberAttr":{"type":"string"},"groupNameAttr":{"type":"string"},"groupObjectClass":{"type":"string"},"groupObjectFilter":{"type":"string"},"userDNaddition":{"type":"string"},"userObjectClass":{"type":"string"},"userGroupMemberAttr":{"type":"string"},"userFirstnameAttr":{"type":"string"},"userLastnameAttr":{"type":"string"},"userDisplayNameAttr":{"type":"string"},"userMailAttr":{"type":"string"},"userNameAttr":{"type":"string"},"userNameRdnAttr":{"type":"string"},"userPasswordAttr":{"type":"string"},"userObjectFilter":{"type":"string"},"userExternalIdAttr":{"type":"string"}},"additionalProperties":false,"required":["referral"]}

Responses

Status 400
Returned if the entity contains invalid values for fields

Status 204
Returned if the connection was successfully made

Status 409
Returned if there was a problem with connecting to the LDAP server

Test search`POST /rest/directorymanagement/1/directory/testsearch`

Tests search with the provided LDAP directory configuration

Request

Example

{"strategy":"GROUP","url":"ldap://localhost:389/","secureMode":"false","referral":false,"baseDN":"dc=test,dc=com","userDN":"cn=admin,dc=test,dc=com","ldapPassword":"admin","filterExpiredUsers":false,"primaryGroupSupport":false,"useUserMembershipAttribute":false,"useUserMembershipAttributeForGroupMembership":false,"useRelaxedDNStandardisation":false,"pagedResults":false,"groupNameAttr":"cn","groupObjectFilter":"(objectCategory=Group)","connector":"com.atlassian.crowd.directory.OpenLDAP"}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/ldap-search-test-entity#","title":"Ldap Search Test Entity","type":"object","properties":{"strategy":{"type":"string"},"url":{"type":"string"},"secureMode":{"type":"string","enum":["false","true","starttls"]},"referral":{"type":"boolean"},"baseDN":{"type":"string"},"userDN":{"type":"string"},"ldapPassword":{"type":"string"},"userEncryptionMethod":{"type":"string"},"filterExpiredUsers":{"type":"boolean"},"primaryGroupSupport":{"type":"boolean"},"useUserMembershipAttribute":{"type":"boolean"},"useUserMembershipAttributeForGroupMembership":{"type":"boolean"},"useRelaxedDNStandardisation":{"type":"boolean"},"pagedResults":{"type":"boolean"},"pagedResultsSize":{"type":"integer"},"groupDNaddition":{"type":"string"},"groupDescriptionAttr":{"type":"string"},"groupMemberAttr":{"type":"string"},"groupNameAttr":{"type":"string"},"groupObjectClass":{"type":"string"},"groupObjectFilter":{"type":"string"},"userDNaddition":{"type":"string"},"userObjectClass":{"type":"string"},"userGroupMemberAttr":{"type":"string"},"userFirstnameAttr":{"type":"string"},"userLastnameAttr":{"type":"string"},"userDisplayNameAttr":{"type":"string"},"userMailAttr":{"type":"string"},"userNameAttr":{"type":"string"},"userNameRdnAttr":{"type":"string"},"userPasswordAttr":{"type":"string"},"userObjectFilter":{"type":"string"},"userExternalIdAttr":{"type":"string"},"connector":{"type":"string"}},"additionalProperties":false,"required":["referral","filterExpiredUsers","primaryGroupSupport","useUserMembershipAttribute","useUserMembershipAttributeForGroupMembership","useRelaxedDNStandardisation","pagedResults"]}

Responses

Status 400
Returned if the entity contains invalid values for fields

Status 204
Returned if the search returned results was successfully made

Status 409
Returned if the search did not return any results, or there was a problem with connecting to the directory

Test search`POST /rest/directorymanagement/1/directory/testsearch/{id}`

Tests search with the provided LDAP directory configuration

Request

Example

{"strategy":"GROUP","url":"ldap://localhost:389/","secureMode":"false","referral":false,"baseDN":"dc=test,dc=com","userDN":"cn=admin,dc=test,dc=com","ldapPassword":"admin","filterExpiredUsers":false,"primaryGroupSupport":false,"useUserMembershipAttribute":false,"useUserMembershipAttributeForGroupMembership":false,"useRelaxedDNStandardisation":false,"pagedResults":false,"groupNameAttr":"cn","groupObjectFilter":"(objectCategory=Group)","connector":"com.atlassian.crowd.directory.OpenLDAP"}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/ldap-search-test-entity#","title":"Ldap Search Test Entity","type":"object","properties":{"strategy":{"type":"string"},"url":{"type":"string"},"secureMode":{"type":"string","enum":["false","true","starttls"]},"referral":{"type":"boolean"},"baseDN":{"type":"string"},"userDN":{"type":"string"},"ldapPassword":{"type":"string"},"userEncryptionMethod":{"type":"string"},"filterExpiredUsers":{"type":"boolean"},"primaryGroupSupport":{"type":"boolean"},"useUserMembershipAttribute":{"type":"boolean"},"useUserMembershipAttributeForGroupMembership":{"type":"boolean"},"useRelaxedDNStandardisation":{"type":"boolean"},"pagedResults":{"type":"boolean"},"pagedResultsSize":{"type":"integer"},"groupDNaddition":{"type":"string"},"groupDescriptionAttr":{"type":"string"},"groupMemberAttr":{"type":"string"},"groupNameAttr":{"type":"string"},"groupObjectClass":{"type":"string"},"groupObjectFilter":{"type":"string"},"userDNaddition":{"type":"string"},"userObjectClass":{"type":"string"},"userGroupMemberAttr":{"type":"string"},"userFirstnameAttr":{"type":"string"},"userLastnameAttr":{"type":"string"},"userDisplayNameAttr":{"type":"string"},"userMailAttr":{"type":"string"},"userNameAttr":{"type":"string"},"userNameRdnAttr":{"type":"string"},"userPasswordAttr":{"type":"string"},"userObjectFilter":{"type":"string"},"userExternalIdAttr":{"type":"string"},"connector":{"type":"string"}},"additionalProperties":false,"required":["referral","filterExpiredUsers","primaryGroupSupport","useUserMembershipAttribute","useUserMembershipAttributeForGroupMembership","useRelaxedDNStandardisation","pagedResults"]}

Responses

Status 400
Returned if the entity contains invalid values for fields

Status 204
Returned if the search returned results was successfully made

Status 409
Returned if the search did not return any results, or there was a problem with connecting to the directory

usermanagement/1/authentication

User Authentication Resource.

Authenticate user`POST /rest/usermanagement/1/authentication`

Authenticates a user. Does not generate an SSO token. For SSO please take a look at the SSO token resource.

Request

query parameters

parameter	type	description
`username`	string	name of the user

Example

{"value":"hunter2"}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/password-entity#","title":"Password Entity","type":"object","properties":{"link":{"title":"Link","type":"object","properties":{"href":{"type":"string","format":"uri"},"type":{"type":"string"},"rel":{"type":"string"}},"additionalProperties":false},"value":{"type":"string"}},"additionalProperties":false}

Responses

Status 200

Example

{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user?username=sampleuser","rel":"self"},"name":"sampleuser","password":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/password?username=sampleuser","rel":"edit"}},"key":"557057:927441f1-cc92-4030-b633-8a2bbdf7136e","active":true,"attributes":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"},"attribute":[{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts","rel":"self"},"name":"invalidPasswordAttempts","values":["0"]},{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"},"name":"requiresPasswordChange","values":["false"]}]},"first-name":"Sample","last-name":"User","display-name":"Sample User","email":"sample@user.cool"}

Returned if successful

Status 400
Returned if unsuccessful (for example the user doesn't exist or can't access the application)

User authenticated experimental`POST /rest/usermanagement/1/authentication/notify`

Notifies Crowd that a user has logged into an application, using a method different than the default /authentication or /session resources. Does not initiate a SSO session.

This allows to trigger side effects in Crowd, such as updating the user from the remote directory, or applying automatic group assignments.

Request

query parameters

parameter	type	description
`username`	string	name of the user

Responses

Status 200

Example

{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user?username=sampleuser","rel":"self"},"name":"sampleuser","password":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/password?username=sampleuser","rel":"edit"}},"key":"557057:927441f1-cc92-4030-b633-8a2bbdf7136e","active":true,"attributes":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"},"attribute":[{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts","rel":"self"},"name":"invalidPasswordAttempts","values":["0"]},{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"},"name":"requiresPasswordChange","values":["false"]}]},"first-name":"Sample","last-name":"User","display-name":"Sample User","email":"sample@user.cool"}

Returned if successful

Status 400
Returned if unsuccessful (for example the user doesn't exist or can't access the application)

Get config`GET /rest/usermanagement/1/config/cookie`

Returns the Cookie configuration information.

Responses

Status 200
Example
```
{"domain":".atlassian.com","secure":true,"name":"cookie-name"}
```
Returned if successful

usermanagement/1/group

Remove group`DELETE /rest/usermanagement/1/group`

Deletes a group.

Request

query parameters

parameter	type	description
`groupname`	string	Name of the group to delete.

Responses

Status 204
Returned if the group was found and deleted.

Status 404
Returned if the group could not be found.

Get group`GET /rest/usermanagement/1/group`

Retrieves a group.

Request

query parameters

parameter	type	description
`groupname`	string	Name of the group to retrieve.

Responses

Status 200

Example

{"link":{"href":"link_to_group","rel":"self"},"name":"groupname","description":"Group Description","type":"GROUP","active":true,"attributes":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname","rel":"self"},"attribute":[]}}

Returned if the group was found.

Status 404
Returned if the group was not found.

Add group`POST /rest/usermanagement/1/group`

Adds a new group.

Request

Example

{"name":"newgroupname","description":"description","type":"GROUP"}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/group-entity#","title":"Group Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["GROUP","LEGACY_ROLE"]},"active":{"type":"boolean"},"attributes":{"title":"Multi Valued Attribute Entity List","type":"object","properties":{"attribute":{"type":"array","items":{"title":"Multi Valued Attribute Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"link":{"$ref":"#/definitions/link"}},"additionalProperties":false}},"definitions":{"link":{"title":"Link","type":"object","properties":{"href":{"type":"string","format":"uri"},"type":{"type":"string"},"rel":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

Responses

Status 201

Example

{"link":{"href":"link_to_group","rel":"self"},"name":"groupname","description":"Group Description","type":"GROUP","active":true,"attributes":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname","rel":"self"},"attribute":[]}}

Returned if the group is successfully created.

Status 400
Returned if the group already exists.

Status 403
Returned if the application is not allowed to create a new group.

Update group`PUT /rest/usermanagement/1/group`

Updates an existing group.

Request

query parameters

parameter	type	description
`groupname`	string	the name of the group to update.

Example

{"name":"newgroupname","description":"description","type":"GROUP"}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/group-entity#","title":"Group Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["GROUP","LEGACY_ROLE"]},"active":{"type":"boolean"},"attributes":{"title":"Multi Valued Attribute Entity List","type":"object","properties":{"attribute":{"type":"array","items":{"title":"Multi Valued Attribute Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"link":{"$ref":"#/definitions/link"}},"additionalProperties":false}},"definitions":{"link":{"title":"Link","type":"object","properties":{"href":{"type":"string","format":"uri"},"type":{"type":"string"},"rel":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

Responses

Status 200

Example

{"link":{"href":"link_to_group","rel":"self"},"name":"groupname","description":"Group Description","type":"GROUP","active":true,"attributes":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname","rel":"self"},"attribute":[]}}

Returned if the group previously existed and is now updated.

Status 400
Returned if the groupname in the request body and the URI do not match.

Status 403
Returned if the application is not allowed to update/create a group.

Status 404
Returned if the group does not exist.

Delete group attribute`DELETE /rest/usermanagement/1/group/attribute`

Deletes a group attribute.

Request

query parameters

parameter	type	description
`groupname`	string	name of the group.
`attributename`	string	name of the attribute to delete.

Responses

Status 204
Returned if the group attribute is successfully deleted.

Status 403
Returned if the application is not allowed to remove a group attribute.

Status 404
Returned if the group or attribute could not be found.

Get group attributes`GET /rest/usermanagement/1/group/attribute`

Retrieves a list of group attributes.

Request

query parameters

parameter	type	description
`groupname`	string	Name of the group to fetch attributes from.

Responses

Status 200

Example

{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/group/attributes?username=sampleuser","rel":"self"},"attribute":[{"link":{"href":"https://crowdserver/crowd","rel":"self"},"name":"attribute","values":["value1","value2"]}]}

Returned if the group attribute was found.

Status 404
Returned if the group attribute could not be found.

Store group attributes`POST /rest/usermanagement/1/group/attribute`

Stores the group attributes.

Request

query parameters

parameter	type	description
`groupname`	string	name of the group.

Example

{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/group/attributes?username=sampleuser","rel":"self"},"attribute":[{"link":{"href":"https://crowdserver/crowd","rel":"self"},"name":"attribute","values":["value1","value2"]}]}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/multi-valued-attribute-entity-list#","title":"Multi Valued Attribute Entity List","type":"object","properties":{"attribute":{"type":"array","items":{"title":"Multi Valued Attribute Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"link":{"$ref":"#/definitions/link"}},"definitions":{"link":{"title":"Link","type":"object","properties":{"href":{"type":"string","format":"uri"},"type":{"type":"string"},"rel":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

Responses

Status 204
Returned if the group attributes are successfully set.

Status 403
Returned if the application is not allowed to set group attributes.

Status 404
Returned if the group attribute could not be found.

Remove direct child group membership`DELETE /rest/usermanagement/1/group/child-group/direct`

Deletes a child group membership.

Request

query parameters

parameter	type	description
`groupname`	string	Name of the parent group.
`child-groupname`	string	Name of the child group.

Responses

Status 204
Returned if the child group membership is deleted.

Status 404
Returned if the child or parent group could not be found.

Get direct children of group`GET /rest/usermanagement/1/group/child-group/direct`

Retrieves the groups that are direct children of the specified group or a single direct child of that group with the specified name.

Request

query parameters

parameter	type	description
`groupname`	string	Name of the parent group which will have its children fetched.
`child-groupname`	string	If specified then only the direct child group with this name will be returned.
`start-index`	int Default: `0`	start index if using paged queries, only applicable when `child-groupname` is not provided.
`max-results`	int Default: `1000`	maximum amount of results to return, only applicable when `child-groupname` is not provided.

Responses

Status 200

Example

{"group":[{"link":{"href":"link_to_group","rel":"self"},"name":"groupname","description":"Group Description","type":"GROUP","active":true,"attributes":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname","rel":"self"},"attribute":[]}},{"link":{"href":"link_to_group","rel":"self"},"name":"groupname","description":"Group Description","type":"GROUP","active":true,"attributes":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname","rel":"self"},"attribute":[]}}]}

Returned if the group was found.

Status 404
Returned if the group could not be found.

Add direct child group membership`POST /rest/usermanagement/1/group/child-group/direct`

Adds a direct child group membership.

Request

query parameters

parameter	type	description
`groupname`	string	Name of the parent group to which the direct child group will be added.

Example

{"name":"groupname"}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/group-entity#","title":"Group Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["GROUP","LEGACY_ROLE"]},"active":{"type":"boolean"},"attributes":{"title":"Multi Valued Attribute Entity List","type":"object","properties":{"attribute":{"type":"array","items":{"title":"Multi Valued Attribute Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"link":{"$ref":"#/definitions/link"}},"additionalProperties":false}},"definitions":{"link":{"title":"Link","type":"object","properties":{"href":{"type":"string","format":"uri"},"type":{"type":"string"},"rel":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

Responses

Status 201
Example
```
"https://crowdserver/crowd/group/user/direct?groupname=group&username=user"
```
Returned if the child group membership is successfully added.

Status 400
Returned if the child group could not be found, or adding the membership would result in a circular dependency.

Status 404
Returned if the group could not be found.

Get nested children of group`GET /rest/usermanagement/1/group/child-group/nested`

Retrieves nested children of the specified group or a single nested child of that group with the specified name.

Request

query parameters

parameter	type	description
`groupname`	string	Name of the parent group which will have its nested children fetched.
`child-groupname`	string	If provided then only a single nested child group with this name will be fetched from the group specified by `groupname`.
`start-index`	int Default: `0`	start index if using paged queries, only applicable when `child-groupname` is not provided.
`max-results`	int Default: `1000`	maximum amount of results to return, only applicable when `child-groupname` is not provided.

Responses

Status 200

Example

{"group":[{"link":{"href":"link_to_group","rel":"self"},"name":"groupname","description":"Group Description","type":"GROUP","active":true,"attributes":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname","rel":"self"},"attribute":[]}},{"link":{"href":"link_to_group","rel":"self"},"name":"groupname","description":"Group Description","type":"GROUP","active":true,"attributes":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname","rel":"self"},"attribute":[]}}]}

Returned if the groups were found.

Status 404
Returned if the groups could not be found.

Get all memberships`GET /rest/usermanagement/1/group/membership`

Retrieves full details of all group memberships, with users and nested groups. This resource is optimised for streaming XML responses, and does not support JSON responses.

Responses

Status 200
Returned on success.

Status 404
Returned if unavailable in earlier releases of Crowd.

Get direct parents of group`GET /rest/usermanagement/1/group/parent-group/direct`

Retrieves the groups that are direct parents of the specified group or a direct parent group of the specified child group.

Request

query parameters

parameter	type	description
`groupname`	string	if `child-groupname` is specified then the direct parents of this group will be returned. Otherwise this is the direct parent group.
`child-groupname`	string	if specified this will return a single direct parent group of this group with the name `groupname`.
`start-index`	int Default: `0`	start index if using paged queries, only applicable when `child-groupname` is not provided.
`max-results`	int Default: `1000`	maximum amount of results to return, only applicable when `child-groupname` is not provided.

Responses

Status 200

Example

{"group":[{"link":{"href":"link_to_group","rel":"self"},"name":"groupname","description":"Group Description","type":"GROUP","active":true,"attributes":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname","rel":"self"},"attribute":[]}},{"link":{"href":"link_to_group","rel":"self"},"name":"groupname","description":"Group Description","type":"GROUP","active":true,"attributes":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname","rel":"self"},"attribute":[]}}]}

Returned if the group is found.

Status 404
Returned if the group could not be found.

Add direct parent group membership`POST /rest/usermanagement/1/group/parent-group/direct`

Adds a direct parent group membership.

Request

query parameters

parameter	type	description
`groupname`	string	name of the child group.

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/group-entity#","title":"Group Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["GROUP","LEGACY_ROLE"]},"active":{"type":"boolean"},"attributes":{"title":"Multi Valued Attribute Entity List","type":"object","properties":{"attribute":{"type":"array","items":{"title":"Multi Valued Attribute Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"link":{"$ref":"#/definitions/link"}},"additionalProperties":false}},"definitions":{"link":{"title":"Link","type":"object","properties":{"href":{"type":"string","format":"uri"},"type":{"type":"string"},"rel":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

Responses

Status 201
Example
```
"https://crowdserver/crowd/group/user/direct?groupname=group&username=user"
```
Returned if the parent group membership is successfully added.

Status 400
Returned if the parent group could not be found, or adding the membership would result in a circular dependency.

Status 404
Returned if the group could not be found.

Get nested parent groups`GET /rest/usermanagement/1/group/parent-group/nested`

Retrieves the groups that are nested parents of the specified group or a single nested parent of that group with the specified name.

Request

query parameters

parameter	type	description
`groupname`	string	name of the group of which the nested parents will be returned.
`parent-groupname`	string	if specified then the single nested parent group with this name of the group specified by `groupname` will be returned.
`start-index`	int Default: `0`	start index if using paged queries, only applicable when `parent-groupname` is not provided.
`max-results`	int Default: `1000`	maximum amount of results to return, only applicable when `parent-groupname` is not provided.

Responses

Status 200

Example

{"group":[{"link":{"href":"link_to_group","rel":"self"},"name":"groupname","description":"Group Description","type":"GROUP","active":true,"attributes":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname","rel":"self"},"attribute":[]}},{"link":{"href":"link_to_group","rel":"self"},"name":"groupname","description":"Group Description","type":"GROUP","active":true,"attributes":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname","rel":"self"},"attribute":[]}}]}

Returned if the group was found.

Status 404
Returned if the group could not be found.

Remove direct group membership`DELETE /rest/usermanagement/1/group/user/direct`

Removes the user membership.

Request

query parameters

parameter	type	description
`groupname`	string	name of the group from which the user membership will be removed.
`username`	string	name the user to have their membership removed.

Responses

Status 204
Returned if the user membership is successfully deleted.

Status 404
Returned if the user or group could not be found.

Get direct members of group`GET /rest/usermanagement/1/group/user/direct`

Retrieves the users that are direct members of the specified group or a specified user who is a direct member of that group.

Request

query parameters

parameter	type	description
`groupname`	string	name of the group.
`username`	string	if specified it will return a single user if the user is a direct member of the specified group.
`start-index`	int Default: `0`	start index if using paged queries, only applicable when `username` is not provided.
`max-results`	int Default: `1000`	maximum amount of results to return, only applicable when `username` is not provided.

Responses

Status 200

Example

{"user":[{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user?username=sampleuser","rel":"self"},"name":"sampleuser","password":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/password?username=sampleuser","rel":"edit"}},"key":"557057:927441f1-cc92-4030-b633-8a2bbdf7136e","active":true,"attributes":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"},"attribute":[{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts","rel":"self"},"name":"invalidPasswordAttempts","values":["0"]},{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"},"name":"requiresPasswordChange","values":["false"]}]},"first-name":"Sample","last-name":"User","display-name":"Sample User","email":"sample@user.cool"},{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user?username=sampleuser","rel":"self"},"name":"sampleuser","password":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/password?username=sampleuser","rel":"edit"}},"key":"557057:927441f1-cc92-4030-b633-8a2bbdf7136e","active":true,"attributes":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"},"attribute":[{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts","rel":"self"},"name":"invalidPasswordAttempts","values":["0"]},{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"},"name":"requiresPasswordChange","values":["false"]}]},"first-name":"Sample","last-name":"User","display-name":"Sample User","email":"sample@user.cool"}]}

Returned if the group is found.

Status 404
Returned if the group could not be found or the specified user is not a direct member of the group.

Add user as direct group member`POST /rest/usermanagement/1/group/user/direct`

Adds a user as a direct member of the specified group.

Request

query parameters

parameter	type	description
`groupname`	string	name of the group to which the user will be added.

Example

{"name":"sampleuser"}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/user-entity#","title":"User Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"name":{"type":"string"},"first-name":{"type":"string"},"last-name":{"type":"string"},"display-name":{"type":"string"},"directory-id":{"type":"integer"},"email":{"type":"string"},"password":{"$ref":"#/definitions/password-entity"},"encrypted-password":{"$ref":"#/definitions/password-entity"},"key":{"type":"string"},"created-date":{"type":"string"},"updated-date":{"type":"string"},"directory-name":{"type":"string"},"active":{"type":"boolean"},"attributes":{"title":"Multi Valued Attribute Entity List","type":"object","properties":{"attribute":{"type":"array","items":{"title":"Multi Valued Attribute Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"link":{"$ref":"#/definitions/link"}},"additionalProperties":false}},"definitions":{"link":{"title":"Link","type":"object","properties":{"href":{"type":"string","format":"uri"},"type":{"type":"string"},"rel":{"type":"string"}},"additionalProperties":false},"password-entity":{"title":"Password Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"value":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

Responses

Status 201
Example
```
"https://crowdserver/crowd/group/user/direct?groupname=group&username=user"
```
Returned if the user is successfully added as a member of the group.

Status 400
Returned if the user could not be found or groupName is not specified or user has no name.

Status 404
Returned if the group could not be found.

Status 409
Returned if the user is already a direct member of the group.

Get nested members of group`GET /rest/usermanagement/1/group/user/nested`

Retrieves the users that are nested members of the specified group or a single user who is a nested member of the specified group.

Request

query parameters

parameter	type	description
`groupname`	string	name of the group.
`username`	string	if specified it will return a single user if the user is a nested member of the specified group.
`start-index`	int Default: `0`	start index if using paged queries, only applicable `when username` is not provided.
`max-results`	int Default: `1000`	maximum amount of results to return, only applicable when `username` is not provided.

Responses

Status 200

Example

{"user":[{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user?username=sampleuser","rel":"self"},"name":"sampleuser","password":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/password?username=sampleuser","rel":"edit"}},"key":"557057:927441f1-cc92-4030-b633-8a2bbdf7136e","active":true,"attributes":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"},"attribute":[{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts","rel":"self"},"name":"invalidPasswordAttempts","values":["0"]},{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"},"name":"requiresPasswordChange","values":["false"]}]},"first-name":"Sample","last-name":"User","display-name":"Sample User","email":"sample@user.cool"},{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user?username=sampleuser","rel":"self"},"name":"sampleuser","password":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/password?username=sampleuser","rel":"edit"}},"key":"557057:927441f1-cc92-4030-b633-8a2bbdf7136e","active":true,"attributes":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"},"attribute":[{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts","rel":"self"},"name":"invalidPasswordAttempts","values":["0"]},{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"},"name":"requiresPasswordChange","values":["false"]}]},"first-name":"Sample","last-name":"User","display-name":"Sample User","email":"sample@user.cool"}]}

Returned if the group is found.

Status 404
Returned if the user or group could not be found or the specified user is not a nested member of the group.

usermanagement/1/search

Search resource.

Search by cql`GET /rest/usermanagement/1/search`

Searches for entities of entity-type (either 'user' or 'group') with the specified search restriction (as Crowd Query Language).

Request

query parameters

parameter	type	description
`entity-type`	string	type of the entity to search
`max-results`	int Default: `1000`	maximum number of results returned
`start-index`	int Default: `0`	starting index of the results
`restriction`	string Default:	restriction entities must satisfy in the Crowd Query Language

Responses

Status 200

Example

{"user":[{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user?username=sampleuser","rel":"self"},"name":"sampleuser"}]}

list of users or groups

Status 409
when the entity type is not specified or unknown

Search`POST /rest/usermanagement/1/search`

Searches for entities of entity-type (either 'user' or 'group') satisfying the given search restriction.

Request

query parameters

parameter	type	description
`entity-type`	string	type of the entity to search
`max-results`	int Default: `1000`	maximum number of results returned
`start-index`	int Default: `0`	starting index of the results

Example

{"property":{"name":"email","type":"STRING"},"value":"bob@example.net","match-mode":"EXACTLY_MATCHES"}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/search-restriction-entity#","title":"Search Restriction Entity","type":"object","anyOf":[{"$ref":"#/definitions/boolean-restriction-entity"},{"$ref":"#/definitions/null-restriction-entity"},{"$ref":"#/definitions/property-restriction-entity"}],"definitions":{"boolean-restriction-entity":{"title":"Boolean Restriction Entity","type":"object","properties":{"boolean-logic":{"type":"string"},"restrictions":{"type":"array","items":{"title":"Search Restriction Entity","type":"object","anyOf":[{"$ref":"#/definitions/boolean-restriction-entity"},{"$ref":"#/definitions/null-restriction-entity"},{"$ref":"#/definitions/property-restriction-entity"}]}}},"additionalProperties":false},"null-restriction-entity":{"title":"Null Restriction Entity","type":"object"},"property-restriction-entity":{"title":"Property Restriction Entity","type":"object","properties":{"property":{"title":"Property Entity","type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}},"additionalProperties":false},"match-mode":{"type":"string"},"value":{"type":"string"}},"additionalProperties":false}}}

Responses

Status 200

Example

{"group":[{"link":{"href":"https://crowdserver/crowd/group?groupname=group&groupname=crowd-administrators","rel":"self"},"name":"crowd-administrators"}]}

list of users or groups

Status 409
when the entity type is not specified or unknown

usermanagement/1/session

Crowd SSO Token Resource.

Delete tokens for user`DELETE /rest/usermanagement/1/session`

Invalidate all tokens for a given user name.

Optionally, a token key can be saved from invalidation if specified in the exclude param

Request

query parameters

parameter	type	description
`username`	string	The user for which the tokens will be invalidated
`exclude`	string	The token to exclude

Responses

Status 400
Returned if the application is not found

Status 204
Returned if successful

Status 404
Returned if the user is not found

Authenticate user`POST /rest/usermanagement/1/session`

Create new session token valid for duration seconds, or for the server default session timeout if no duration is specified or if duration is longer than the server default session timeout.

Either the user password needs to be valid or the validate-password query param must be set to false.

If an ongoing session already exists for the same authentication credentials and validation factors, then that session token is returned.

Request

query parameters

parameter	type	description
`validate-password`	boolean Default: `true`	true if the password should be validated (optional, defaults to true)
`duration`	long Default: `-1`	requested duration of the token, in seconds (optional, defaults to server session duration)

Example

{"username":"my_username","password":"my_password","validation-factors":{"validation-factor":[{"name":"remote_address","value":"127.0.0.1"}]}}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/authentication-context-entity#","title":"Authentication Context Entity","type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"},"validation-factors":{"title":"Validation Factor Entity List","type":"object","properties":{"validation-factor":{"type":"array","items":{"title":"Validation Factor Entity","type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}

Responses

Status 201

Example

{"token":"abc123","user":{"name":"sampleuser"},"link":{"href":"https://crowdserver/crowd/session/abcc123","rel":"self"},"created-date":1464453000000,"expiry-date":1464456600000}

Returned the session creation was successful or an ongoing session already existed. Contains the Crowd SSO token.

Status 400
Returned if the user authentication details are incorrect (e.g., bad password, inactive user, user does not have permission to authenticate with the application).

Invalidate token`DELETE /rest/usermanagement/1/session/{token}`

Invalidates the Crowd SSO token.

Responses

Status 204
Returned if successful

Get session`GET /rest/usermanagement/1/session/{token}`

Retrieves the token with the authenticated user expanded.

Responses

Status 200

Example

{"token":"abc123","user":{"name":"sampleuser"},"link":{"href":"https://crowdserver/crowd/session/abcc123","rel":"self"},"created-date":1464453000000,"expiry-date":1464456600000}

Returned if successfully retrieved

Status 404
Returned if the token is not found

Validate token`POST /rest/usermanagement/1/session/{token}`

Validates the session token. Validating the token keeps the SSO session alive.

Request

Example

{"validation-factor":[{"name":"remote_address","value":"127.0.0.1"}]}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/validation-factor-entity-list#","title":"Validation Factor Entity List","type":"object","properties":{"validation-factor":{"type":"array","items":{"title":"Validation Factor Entity","type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false}

Responses

Status 200

Example

{"token":"abc123","user":{"name":"sampleuser"},"link":{"href":"https://crowdserver/crowd/session/abcc123","rel":"self"},"created-date":1464453000000,"expiry-date":1464456600000}

Returned if successful

Status 400
Returned if the validation factors are incorrect

Status 404
Returned if if the token cannot be found

usermanagement/1/user

Remove user`DELETE /rest/usermanagement/1/user`

Removes a user.

Request

query parameters

parameter	type	description
`username`	string	name of the user to remove

Responses

Status 204
the user was successfully removed

Status 403
the application is not allowed to remove the user

Status 404
the user could not be found

Get user`GET /rest/usermanagement/1/user`

Retrieves the user details. Either username or key query parameter must be present.

The expand parameter can be used to include additional data in the response. This can currently be set to attributes, to include the user's attributes in the response

Request

query parameters

parameter	type	description
`username`	string	name of the user
`key`	string	the key of the user (only observed if userName is null).

Responses

Status 200

Example

{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user?username=sampleuser","rel":"self"},"name":"sampleuser","password":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/password?username=sampleuser","rel":"edit"}},"key":"557057:927441f1-cc92-4030-b633-8a2bbdf7136e","active":true,"attributes":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"},"attribute":[{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts","rel":"self"},"name":"invalidPasswordAttempts","values":["0"]},{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"},"name":"requiresPasswordChange","values":["false"]}]},"first-name":"Sample","last-name":"User","display-name":"Sample User","email":"sample@user.cool"}

the representation of the found user

Status 404
when the user cannot be found

Add user`POST /rest/usermanagement/1/user`

Creates a new user

Request

Example

{"name":"sampleuser","password":{"value":"secret"},"active":true,"first-name":"Sample","last-name":"User","display-name":"Sample User","email":"sample@user.cool"}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/user-entity#","title":"User Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"name":{"type":"string"},"first-name":{"type":"string"},"last-name":{"type":"string"},"display-name":{"type":"string"},"directory-id":{"type":"integer"},"email":{"type":"string"},"password":{"$ref":"#/definitions/password-entity"},"encrypted-password":{"$ref":"#/definitions/password-entity"},"key":{"type":"string"},"created-date":{"type":"string"},"updated-date":{"type":"string"},"directory-name":{"type":"string"},"active":{"type":"boolean"},"attributes":{"title":"Multi Valued Attribute Entity List","type":"object","properties":{"attribute":{"type":"array","items":{"title":"Multi Valued Attribute Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"link":{"$ref":"#/definitions/link"}},"additionalProperties":false}},"definitions":{"link":{"title":"Link","type":"object","properties":{"href":{"type":"string","format":"uri"},"type":{"type":"string"},"rel":{"type":"string"}},"additionalProperties":false},"password-entity":{"title":"Password Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"value":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

Responses

Status 201

Example

{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user?username=sampleuser","rel":"self"},"name":"sampleuser","password":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/password?username=sampleuser","rel":"edit"}},"key":"557057:927441f1-cc92-4030-b633-8a2bbdf7136e","active":true,"attributes":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"},"attribute":[{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts","rel":"self"},"name":"invalidPasswordAttempts","values":["0"]},{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"},"name":"requiresPasswordChange","values":["false"]}]},"first-name":"Sample","last-name":"User","display-name":"Sample User","email":"sample@user.cool"}

the user was successfully created

Status 400
invalid user data, for example missing password or the user already exists

Status 403
the application is not allowed to create a new user

Update user`PUT /rest/usermanagement/1/user`

Updates a user.

Request

query parameters

parameter	type	description
`username`	string	name of the user to update

Example

{"name":"sampleuser","password":{"value":"secret"},"active":true,"first-name":"Sample","last-name":"User","display-name":"Sample User","email":"sample@user.cool"}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/user-entity#","title":"User Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"name":{"type":"string"},"first-name":{"type":"string"},"last-name":{"type":"string"},"display-name":{"type":"string"},"directory-id":{"type":"integer"},"email":{"type":"string"},"password":{"$ref":"#/definitions/password-entity"},"encrypted-password":{"$ref":"#/definitions/password-entity"},"key":{"type":"string"},"created-date":{"type":"string"},"updated-date":{"type":"string"},"directory-name":{"type":"string"},"active":{"type":"boolean"},"attributes":{"title":"Multi Valued Attribute Entity List","type":"object","properties":{"attribute":{"type":"array","items":{"title":"Multi Valued Attribute Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"link":{"$ref":"#/definitions/link"}},"additionalProperties":false}},"definitions":{"link":{"title":"Link","type":"object","properties":{"href":{"type":"string","format":"uri"},"type":{"type":"string"},"rel":{"type":"string"}},"additionalProperties":false},"password-entity":{"title":"Password Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"value":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

Responses

Status 400
invalid user data, for example the usernames in the body and the uri don't match

Status 204
the user was successfully updated

Status 403
the application is not allowed to update a user

Status 404
the user doesn't exist

Remove user attribute`DELETE /rest/usermanagement/1/user/attribute`

Deletes a user attribute.

Request

query parameters

parameter	type	description
`username`	string	name of the user
`attributename`	string	name of the attribute to delete

Responses

Status 204
the attributes was successfully deleted, or the attribute was not defined for the user

Status 403
the application is not allowed to delete attributes

Status 404
the user could not be found

Get user attributes`GET /rest/usermanagement/1/user/attribute`

Retrieves a list of user attributes

Request

query parameters

parameter	type	description
`username`	string	name of the user

Responses

Status 200

Example

{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"},"attribute":[{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts","rel":"self"},"name":"invalidPasswordAttempts","values":["0"]},{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"},"name":"requiresPasswordChange","values":["false"]}]}

Status 404
the user could not be found

Store user attributes`POST /rest/usermanagement/1/user/attribute`

Stores the user attributes. Attribute values will not be overwritten if not specified in attributes.

Request

query parameters

parameter	type	description
`username`	string	name of the user

Example

{"attribute":[{"name":"invalidPasswordAttempts","values":["0"]},{"name":"requiresPasswordChange","values":["false"]}]}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/multi-valued-attribute-entity-list#","title":"Multi Valued Attribute Entity List","type":"object","properties":{"attribute":{"type":"array","items":{"title":"Multi Valued Attribute Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"link":{"$ref":"#/definitions/link"}},"definitions":{"link":{"title":"Link","type":"object","properties":{"href":{"type":"string","format":"uri"},"type":{"type":"string"},"rel":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

Responses

Status 204
the attributes were successfully updated

Status 403
the application is not allowed to set attributes

Status 404
the user could not be found

Get avatar for user experimental`GET /rest/usermanagement/1/user/avatar`

Returns the url of the user's avatar

Request

query parameters

parameter	type	description
`username`	string	the name of the user
`s`	int Default: `128`	the requested avatar size in pixels

Responses

Status 303
the uri for the user's avatar (in the location header)

Status 404
the user doesn't exist, or doesn't have an avatar defined

Expire all passwords experimental`POST /rest/usermanagement/1/user/expire-all-passwords`

Expires all passwords for all directories which are part of this application, regardless of group mapping.

Request

query parameters

parameter	type	description
`confirm`	boolean	must be true to take the action. This is so all passwords cannot accidentally be expired.

Responses

Status 500
if any of the directories fail to expire all passwords. This can lead to only some of the users having expired passwords.

Status 204
the operation was successful

Remove user from group`DELETE /rest/usermanagement/1/user/group/direct`

Removes a user from a group.

Request

query parameters

parameter	type	description
`username`	string	name of the user
`groupname`	string	name of the group

Responses

Status 204
the user was successfully removed from the group

Status 403
the application is not allowed to delete the membership

Status 404
the user or group could not be found

Get direct groups`GET /rest/usermanagement/1/user/group/direct`

Returns the a list of groups the user is a direct member of.

Request

query parameters

parameter	type	description
`username`	string	name of the user
`groupname`	string	name of the group (optional). If null, then all the groups that the user is a direct member of, are returned.
`max-results`	int Default: `1000`	maximum number of results to return
`start-index`	int Default: `0`	start index of the result

Responses

Status 200

Example

{"group":[{"link":{"href":"https://crowdserver/crowd/group?groupname=group&groupname=crowd-administrators","rel":"self"},"name":"crowd-administrators"}]}

Status 404
the user could not be found or the user is not a direct member of the specified group.

Add user to group`POST /rest/usermanagement/1/user/group/direct`

Adds a user as a direct member of the group

Request

query parameters

parameter	type	description
`username`	string	name of the user

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/group-entity#","title":"Group Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["GROUP","LEGACY_ROLE"]},"active":{"type":"boolean"},"attributes":{"title":"Multi Valued Attribute Entity List","type":"object","properties":{"attribute":{"type":"array","items":{"title":"Multi Valued Attribute Entity","type":"object","properties":{"link":{"$ref":"#/definitions/link"},"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"link":{"$ref":"#/definitions/link"}},"additionalProperties":false}},"definitions":{"link":{"title":"Link","type":"object","properties":{"href":{"type":"string","format":"uri"},"type":{"type":"string"},"rel":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}

Responses

Status 201
the user was successfully added to the group

Status 400
the group could not be found

Status 403
the application is not allowed to add the membership

Status 404
the user could not be found

Status 409
the user is already a direct member of the group

Get nested groups`GET /rest/usermanagement/1/user/group/nested`

Retrieves the group that the user is a nested member of

Request

query parameters

parameter	type	description
`username`	string	name of the user
`groupname`	string	name of the group (optional). If null, then all the groups that the user is a nested member of, are returned.
`max-results`	int Default: `1000`	maximum number of results to return
`start-index`	int Default: `0`	start index of the result

Responses

Status 200

Example

{"group":[{"link":{"href":"https://crowdserver/crowd/group?groupname=group&groupname=crowd-administrators","rel":"self"},"name":"crowd-administrators"}]}

Status 404
the user could not be found or the user is not a nested member of the specified group.

Request password reset`POST /rest/usermanagement/1/user/mail/password`

Sends the user a password reset link to the user's email address

Request

query parameters

parameter	type	description
`username`	string	name of the user to request a password reset

Responses

Status 500
the operation failed due to an error

Status 204
the operation was successful

Status 403
the application is not allowed to update the user's password

Status 404
the user could not be found

Request usernames reminder`POST /rest/usermanagement/1/user/mail/usernames`

Requests an email to be sent containing usernames associated with the given email address.

Request

query parameters

parameter	type	description
`email`	string	email address of the user

Responses

Status 204
the operation was successful

Status 404
no users with the given email were found

Delete user password`DELETE /rest/usermanagement/1/user/password`

Deletes a user password. This will prevent the user from logging in using a password.

Request

query parameters

parameter	type	description
`username`	string	the name of the user to update the password for

Responses

Status 204
the password was updated

Status 403
the application is not allowed to update a user's password

Status 404
the user could not be found

Update user password`PUT /rest/usermanagement/1/user/password`

Updates a user password.

Request

query parameters

parameter	type	description
`username`	string	the name of the user to update the password for

Example

{"value":"hunter2"}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/password-entity#","title":"Password Entity","type":"object","properties":{"link":{"title":"Link","type":"object","properties":{"href":{"type":"string","format":"uri"},"type":{"type":"string"},"rel":{"type":"string"}},"additionalProperties":false},"value":{"type":"string"}},"additionalProperties":false}

Responses

Status 204
the password was updated

Status 403
the application is not allowed to update a user's password

Status 404
the user could not be found

Rename user`POST /rest/usermanagement/1/user/rename`

Renames a user.

Request

query parameters

parameter	type	description
`username`	string	name of the user to rename

Example

{"new-name":"sampleuser-brandnewname"}

Schema

{"id":"https://docs.atlassian.com/jira/REST/schema/rename-entity#","title":"Rename Entity","type":"object","properties":{"new-name":{"type":"string"}},"additionalProperties":false}

Responses

Status 200

Example

{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user?username=sampleuser","rel":"self"},"name":"sampleuser","password":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/password?username=sampleuser","rel":"edit"}},"key":"557057:927441f1-cc92-4030-b633-8a2bbdf7136e","active":true,"attributes":{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"},"attribute":[{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts","rel":"self"},"name":"invalidPasswordAttempts","values":["0"]},{"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"},"name":"requiresPasswordChange","values":["false"]}]},"first-name":"Sample","last-name":"User","display-name":"Sample User","email":"sample@user.cool"}

the user was successfully renamed

Status 400
the new user name is invalid or already taken

Status 403
the application is not allowed to rename the user

Status 404
the user could not be found

URI Structure

Authentication

Expansion

Pagination

Experimental methods

Resources

Get applications experimentalGET /rest/admin/1.0/application

Request

query parameters

Responses

Get application experimentalGET /rest/admin/1.0/application/{applicationId}

Responses

Update application experimentalPUT /rest/admin/1.0/application/{applicationId}

Request

Schema

Responses

Get application access based synchronization filter experimentalGET /rest/admin/1.0/application/{applicationId}/access-based-synchronization

Responses

Update application access based synchronization filter experimentalPUT /rest/admin/1.0/application/{applicationId}/access-based-synchronization

Request

Schema

Responses

Get application directory mappings experimentalGET /rest/admin/1.0/application/{applicationId}/directory-mapping

Responses

Add application directory mapping experimentalPOST /rest/admin/1.0/application/{applicationId}/directory-mapping

Request

Schema

Responses

Delete application directory mapping experimentalDELETE /rest/admin/1.0/application/{applicationId}/directory-mapping/{directoryId}

Responses

Get application directory mapping experimentalGET /rest/admin/1.0/application/{applicationId}/directory-mapping/{directoryId}

Responses

Update application directory mapping experimentalPUT /rest/admin/1.0/application/{applicationId}/directory-mapping/{directoryId}

Request

Schema

Responses

Reorder application directory mapping experimentalPOST /rest/admin/1.0/application/{applicationId}/directory-mapping/{directoryId}/move

Request

Schema

Responses

Get latest scan resultGET /rest/admin/1.0/application/{applicationId}/emailscan

Responses

Trigger email scanPOST /rest/admin/1.0/application/{applicationId}/emailscan

Responses

Add changesetPOST /rest/admin/1.0/auditlog

Request

Schema

Responses

Get configurationGET /rest/admin/1.0/auditlog/configuration

Responses

Set configurationPUT /rest/admin/1.0/auditlog/configuration

Request

Schema

Responses

Search audit log experimentalPOST /rest/admin/1.0/auditlog/query

Request

Schema

Responses

Get filter values experimentalPOST /rest/admin/1.0/auditlog/query/filter

Request

query parameters

Schema

Responses

Create backupPOST /rest/admin/1.0/backup

Request

Schema

Responses

Get backup configurationGET /rest/admin/1.0/backup/configuration

Responses

Save backup configurationPOST /rest/admin/1.0/backup/configuration

Request

Schema

Responses

Get backup informationGET /rest/admin/1.0/backup/summary

Responses

Get detailed directories experimentalGET /rest/admin/1.0/directory/detailed

Request

query parameters

Responses

Get detailed directory experimentalGET /rest/admin/1.0/directory/detailed/{directoryId}

Get applications experimental`GET /rest/admin/1.0/application`

Get application experimental`GET /rest/admin/1.0/application/{applicationId}`

Update application experimental`PUT /rest/admin/1.0/application/{applicationId}`

Get application access based synchronization filter experimental`GET /rest/admin/1.0/application/{applicationId}/access-based-synchronization`

Update application access based synchronization filter experimental`PUT /rest/admin/1.0/application/{applicationId}/access-based-synchronization`

Get application directory mappings experimental`GET /rest/admin/1.0/application/{applicationId}/directory-mapping`

Add application directory mapping experimental`POST /rest/admin/1.0/application/{applicationId}/directory-mapping`

Delete application directory mapping experimental`DELETE /rest/admin/1.0/application/{applicationId}/directory-mapping/{directoryId}`

Get application directory mapping experimental`GET /rest/admin/1.0/application/{applicationId}/directory-mapping/{directoryId}`

Update application directory mapping experimental`PUT /rest/admin/1.0/application/{applicationId}/directory-mapping/{directoryId}`

Reorder application directory mapping experimental`POST /rest/admin/1.0/application/{applicationId}/directory-mapping/{directoryId}/move`

Get latest scan result`GET /rest/admin/1.0/application/{applicationId}/emailscan`

Trigger email scan`POST /rest/admin/1.0/application/{applicationId}/emailscan`

Add changeset`POST /rest/admin/1.0/auditlog`

Get configuration`GET /rest/admin/1.0/auditlog/configuration`

Set configuration`PUT /rest/admin/1.0/auditlog/configuration`

Search audit log experimental`POST /rest/admin/1.0/auditlog/query`

Get filter values experimental`POST /rest/admin/1.0/auditlog/query/filter`

Create backup`POST /rest/admin/1.0/backup`

Get backup configuration`GET /rest/admin/1.0/backup/configuration`

Save backup configuration`POST /rest/admin/1.0/backup/configuration`

Get backup information`GET /rest/admin/1.0/backup/summary`

Get detailed directories experimental`GET /rest/admin/1.0/directory/detailed`

Get detailed directory experimental`GET /rest/admin/1.0/directory/detailed/{directoryId}`

Schedule synchronization experimental`POST /rest/admin/1.0/directory/detailed/{directoryId}/synchronize`

Get managed directories experimental`GET /rest/admin/1.0/directory/managed`

Dismiss message`POST /rest/admin/1.0/dismiss/{messageKey}`

Get encryption settings experimental`GET /rest/admin/1.0/encryption`

Change key experimental`PUT /rest/admin/1.0/encryption/changeKey`

Disable encryption experimental`PUT /rest/admin/1.0/encryption/disable`

Set default encryptor experimental`PUT /rest/admin/1.0/encryption/encryptor`

Get nested groups experimental`GET /rest/admin/1.0/group/{groupId}/groups`

Add groups to group experimental`POST /rest/admin/1.0/group/{groupId}/groups`

Search directory groups experimental`GET /rest/admin/1.0/group/search/{directoryId}`

Get group administrators`GET /rest/admin/1.0/group-level-admin/{groupId}/admins`

Add group administrators experimental`POST /rest/admin/1.0/group-level-admin/{groupId}/admins`

Delete group group administrator experimental`DELETE /rest/admin/1.0/group-level-admin/{groupId}/admins/groups/{adminId}`

Get admin candidates`GET /rest/admin/1.0/group-level-admin/{groupId}/admins/suggestions`

Delete user group administrator experimental`DELETE /rest/admin/1.0/group-level-admin/{groupId}/admins/users/{adminId}`

Group details`GET /rest/admin/1.0/groups/{groupId}`

Remove users from group`DELETE /rest/admin/1.0/groups/{groupId}/users`

Group members`GET /rest/admin/1.0/groups/{groupId}/users`

Add users to group`POST /rest/admin/1.0/groups/{groupId}/users`

Search users`GET /rest/admin/1.0/groups/{groupId}/users/suggestions`

Search administered groups experimental`POST /rest/admin/1.0/groups/query`