Crowd REST API Reference

Crowd 3.1.1

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

Currently the following API names are available, which will be discussed further below:

  • usermanagement - intended for applications to interact with the Crowd server for user management operations
  • admin - intended to be used for administrative operations on the Crowd server

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.

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/auditlog

Stores a changeset in the audit log

Request

Example
{"id":1,"timestamp":"2017-04-26T00:00:00.000+0200","authorType":"USER","authorId":1,"authorName":"admin","eventType":"MODIFIED","entityType":"APPLICATION","entityId":1,"entityName":"JIRA 7.4","ipAddress":"127.0.0.1","eventMessage":"Application modified","entries":[{"propertyName":"name","oldValue":"JIRA 7.3","newValue":"JIRA 7.4"}]}

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/audit-log-changeset-rest-entity#","title":"Audit Log Changeset Rest Entity","type":"object","properties":{"id":{"type":"integer"},"timestamp":{"type":"string"},"authorType":{"type":"string","enum":["USER","APPLICATION","SYSTEM","PLUGIN","OTHER"]},"authorId":{"type":"integer"},"authorName":{"type":"string"},"eventType":{"type":"string","enum":["CREATED","MODIFIED","DELETED","STARTED","COMPLETED","FAILED","OTHER"]},"entityType":{"type":"string","enum":["APPLICATION","DIRECTORY","USER","GROUP","CONFIGURATION","RESTORE","OTHER"]},"entityId":{"type":"integer"},"entityName":{"type":"string"},"ipAddress":{"type":"string"},"eventMessage":{"type":"string"},"entries":{"type":"array","items":{"title":"Audit Log Entry Rest Entity","type":"object","properties":{"propertyName":{"type":"string"},"oldValue":{"type":"string"},"newValue":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false}

Responses
  • Status 201
    Returned when given changeset was stored in audit log

Saves new audit log configuration

Request

Example
{"retentionPeriod":"UNLIMITED"}

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 200

    Example
    {"retentionPeriod":"UNLIMITED"}

    Returned if configuration was successfully saved

    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}

Retrieves current audit log configuration

Responses
  • Status 200

    Example
    {"retentionPeriod":"UNLIMITED"}

    Returned if configuration was successfully retrieved

    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}

Searches audit log for entries matching given restrictions

Request
query parameters
parametertypedescription
max-resultsint

Default: 1000

maximum number of results returned

start-indexint

Default: 0

starting index of the results

Example
{"restriction-type":"property-search-restriction","property":{"name":"author","type":"STRING"},"value":"admin","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
    {"changesets":[{"id":1,"timestamp":"2017-04-26T00:00:00.000+0200","authorType":"USER","authorId":1,"authorName":"admin","eventType":"MODIFIED","entityType":"APPLICATION","entityId":1,"entityName":"JIRA 7.4","ipAddress":"127.0.0.1","eventMessage":"Application modified","entries":[{"propertyName":"name","oldValue":"JIRA 7.3","newValue":"JIRA 7.4"}]}]}

    Returned when restriction was valid

usermanagement/1/authentication

User Authentication Resource.

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

Request
query parameters
parametertypedescription
usernamestring

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
    {"expand":"attributes","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":{"attributes":[{"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"]}],"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"}},"first-name":"Sample","last-name":"User","display-name":"Sample User","email":"sample@user.cool"}

    Returned if successful
  • Status 400
    Returned if unsuccessful

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

Retrieves a group.

Request
query parameters
parametertypedescription
groupnamestring

Name of the group to retrieve.

Responses
  • Status 200

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

    Returned if the group was found.
  • Status 404
    Returned if the group was not found.

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":{"attributes":{"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
    {"expand":"attributes","link":{"href":"link_to_group","rel":"self"},"name":"groupname","description":"Group Description","type":"GROUP","active":true,"attributes":{"attributes":[],"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname","rel":"self"}}}

    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.

Deletes a group.

Request
query parameters
parametertypedescription
groupnamestring

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.

Updates an existing group.

Request
query parameters
parametertypedescription
groupnamestring

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":{"attributes":{"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
    {"expand":"attributes","link":{"href":"link_to_group","rel":"self"},"name":"groupname","description":"Group Description","type":"GROUP","active":true,"attributes":{"attributes":[],"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/group/attributes?groupname=groupname","rel":"self"}}}

    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.

Retrieves a list of group attributes.

Request
query parameters
parametertypedescription
groupnamestring

Name of the group to fetch attributes from.

Responses
  • Status 200

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

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

Stores the group attributes.

Request
query parameters
parametertypedescription
groupnamestring

name of the group.

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

Schema
{"id":"https://docs.atlassian.com/jira/REST/schema/multi-valued-attribute-entity-list#","title":"Multi Valued Attribute Entity List","type":"object","properties":{"attributes":{"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.

Deletes a group attribute.

Request
query parameters
parametertypedescription
groupnamestring

name of the group.

attributenamestring

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.

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
parametertypedescription
groupnamestring

Name of the parent group which will have its children fetched.

child-groupnamestring

If specified then only the direct child group with this name will be returned.

start-indexint

Default: 0

start index if using paged queries, only applicable when child-groupname is not provided.

max-resultsint

Default: 1000

maximum amount of results to return, only applicable when child-groupname is not provided.

Responses
  • Status 200

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

    Returned if the group was found.
  • Status 404
    Returned if the group could not be found.

Adds a direct child group membership.

Request
query parameters
parametertypedescription
groupnamestring

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":{"attributes":{"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.

Deletes a child group membership.

Request
query parameters
parametertypedescription
groupnamestring

Name of the parent group.

child-groupnamestring

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.

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

Request
query parameters
parametertypedescription
groupnamestring

Name of the parent group which will have its nested children fetched.

child-groupnamestring

If provided then only a single nested child group with this name will be fetched from the group specified by groupname.

start-indexint

Default: 0

start index if using paged queries, only applicable when child-groupname is not provided.

max-resultsint

Default: 1000

maximum amount of results to return, only applicable when child-groupname is not provided.

Responses
  • Status 200

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

    Returned if the groups were found.
  • Status 404
    Returned if the groups could not be found.

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.

Adds a direct parent group membership.

Request
query parameters
parametertypedescription
groupnamestring

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":{"attributes":{"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.

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

Request
query parameters
parametertypedescription
groupnamestring

if child-groupname is specified then the direct parents of this group will be returned. Otherwise this is the direct parent group.

child-groupnamestring

if specified this will return a single direct parent group of this group with the name groupname.

start-indexint

Default: 0

start index if using paged queries, only applicable when child-groupname is not provided.

max-resultsint

Default: 1000

maximum amount of results to return, only applicable when child-groupname is not provided.

Responses
  • Status 200

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

    Returned if the group is found.
  • Status 404
    Returned if the group could not be found.

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
parametertypedescription
groupnamestring

name of the group of which the nested parents will be returned.

parent-groupnamestring

if specified then the single nested parent group with this name of the group specified by groupname will be returned.

start-indexint

Default: 0

start index if using paged queries, only applicable when parent-groupname is not provided.

max-resultsint

Default: 1000

maximum amount of results to return, only applicable when parent-groupname is not provided.

Responses
  • Status 200

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

    Returned if the group was found.
  • Status 404
    Returned if the group could not be found.

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

Request
query parameters
parametertypedescription
groupnamestring

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":{"attributes":{"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.
  • Status 404
    Returned if the group could not be found.
  • Status 409
    Returned if the user is already a direct member of the group.

Removes the user membership.

Request
query parameters
parametertypedescription
groupnamestring

name of the group from which the user membership will be removed.

usernamestring

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.

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
parametertypedescription
groupnamestring

name of the group.

usernamestring

if specified it will return a single user if the user is a direct member of the specified group.

start-indexint

Default: 0

start index if using paged queries, only applicable when username is not provided.

max-resultsint

Default: 1000

maximum amount of results to return, only applicable when username is not provided.

Responses
  • Status 200

    Example
    {"expand":"user","users":[{"expand":"attributes","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":{"attributes":[{"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"]}],"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"}},"first-name":"Sample","last-name":"User","display-name":"Sample User","email":"sample@user.cool"},{"expand":"attributes","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":{"attributes":[{"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"]}],"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"}},"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.

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
parametertypedescription
groupnamestring

name of the group.

usernamestring

if specified it will return a single user if the user is a nested member of the specified group.

start-indexint

Default: 0

start index if using paged queries, only applicable when username is not provided.

max-resultsint

Default: 1000

maximum amount of results to return, only applicable when username is not provided.

Responses
  • Status 200

    Example
    {"expand":"user","users":[{"expand":"attributes","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":{"attributes":[{"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"]}],"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"}},"first-name":"Sample","last-name":"User","display-name":"Sample User","email":"sample@user.cool"},{"expand":"attributes","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":{"attributes":[{"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"]}],"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"}},"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.

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

Request
query parameters
parametertypedescription
entity-typestring

type of the entity to search

max-resultsint

Default: 1000

maximum number of results returned

start-indexint

Default: 0

starting index of the results

Example
{"restriction-type":"property-search-restriction","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
    {"expand":"group","groups":[{"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 uknown

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

Request
query parameters
parametertypedescription
entity-typestring

type of the entity to search

max-resultsint

Default: 1000

maximum number of results returned

start-indexint

Default: 0

starting index of the results

restrictionstring

Default:

restriction entities must satisfy in the Crowd Query Language

Responses
  • Status 200

    Example
    {"expand":"user","users":[{"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 uknown

usermanagement/1/session

Crowd SSO Token Resource.

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
parametertypedescription
validate-passwordboolean

Default: true

true if the password should be validated (optional, defaults to true)

durationlong

Default: -1

requested duration of the token, in seconds (optional, defaults to server session duration)

Example
{"username":"my_username","password":"my_password","validation-factors":{"validationFactors":[{"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":{"validationFactors":{"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
    {"expand":"user","token":"abc123","user":{"name":"sampleuser"},"link":{"href":"https://crowdserver/crowd/session/abcc123","rel":"self"},"created-date":1464445800000,"expiry-date":1464449400000}

    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 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
parametertypedescription
usernamestring

The user for which the tokens will be invalidated

excludestring

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

Retrieves the token with the authenticated user expanded.

Responses
  • Status 200

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

    Returned if successfully retrieved
  • Status 404
    Returned if the token is not found

Invalidates the Crowd SSO token.

Responses
  • Status 204
    Returned if successful

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

Request

Example
{"validationFactors":[{"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":{"validationFactors":{"type":"array","items":{"title":"Validation Factor Entity","type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false}

Responses
  • Status 200

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

    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

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
parametertypedescription
usernamestring

name of the user

keystring

the key of the user (only observed if userName is null).

Responses
  • Status 200

    Example
    {"expand":"attributes","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":{"attributes":[{"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"]}],"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"}},"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

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":{"attributes":{"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
    {"expand":"attributes","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":{"attributes":[{"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"]}],"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"}},"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

Updates a user.

Request
query parameters
parametertypedescription
usernamestring

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":{"attributes":{"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

Removes a user.

Request
query parameters
parametertypedescription
usernamestring

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

Retrieves a list of user attributes

Request
query parameters
parametertypedescription
usernamestring

name of the user

Responses
  • Status 200

    Example
    {"attributes":[{"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"]}],"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"}}

  • Status 404
    the user could not be found

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

Request
query parameters
parametertypedescription
usernamestring

name of the user

Example
{"attributes":[{"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":{"attributes":{"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

Deletes a user attribute.

Request
query parameters
parametertypedescription
usernamestring

name of the user

attributenamestring

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

Returns the url of the user's avatar

Request
query parameters
parametertypedescription
usernamestring

the name of the user

sint

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

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

Request
query parameters
parametertypedescription
confirmboolean

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

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

Request
query parameters
parametertypedescription
usernamestring

name of the user

groupnamestring

name of the group (optional). If null, then all the groups that the user is a direct member of, are returned.

max-resultsint

Default: 1000

maximum number of results to return

start-indexint

Default: 0

start index of the result

Responses
  • Status 200

    Example
    {"expand":"group","groups":[{"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.

Adds a user as a direct member of the group

Request
query parameters
parametertypedescription
usernamestring

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":{"attributes":{"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

Removes a user from a group.

Request
query parameters
parametertypedescription
usernamestring

name of the user

groupnamestring

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

Retrieves the group that the user is a nested member of

Request
query parameters
parametertypedescription
usernamestring

name of the user

groupnamestring

name of the group (optional). If null, then all the groups that the user is a nested member of, are returned.

max-resultsint

Default: 1000

maximum number of results to return

start-indexint

Default: 0

start index of the result

Responses
  • Status 200

    Example
    {"expand":"group","groups":[{"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.

Looks up a user by the v2 OpenID URL, and returns the user's details

Request
query parameters
parametertypedescription
openidstring

the v2 OpenID URL for the user

Responses
  • Status 200

    Example
    {"expand":"attributes","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":{"attributes":[{"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"]}],"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"}},"first-name":"Sample","last-name":"User","display-name":"Sample User","email":"sample@user.cool"}

    the representation of the found user
  • Status 404
    the user was not found, or the provided url is not a v2 OpenID URL

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

Request
query parameters
parametertypedescription
usernamestring

name of the user to request a password reset

Responses
  • 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

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

Request
query parameters
parametertypedescription
emailstring

email address of the user

Responses
  • Status 204
    the operation was successful
  • Status 404
    no users with the given email were found

Updates a user password.

Request
query parameters
parametertypedescription
usernamestring

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

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

Request
query parameters
parametertypedescription
usernamestring

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

Renames a user.

Request
query parameters
parametertypedescription
usernamestring

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
    {"expand":"attributes","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":{"attributes":[{"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"]}],"link":{"href":"https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange","rel":"self"}},"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