GET

Search by CQL

Searches for entities of entity-type (either 'user' or 'group') with the specified search restriction (see https://developer.atlassian.com/display/CROWDDEV/Crowd+Query+Language)

Request

Query parameters

entity-type

string

Required
max-results

integer

start-index

integer

restriction

string

Responses

list of users or groups is retrieved

application/json application/xml

any

GET/rest/usermanagement/1/search
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/usermanagement/1/search?entity-type={entity-type}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 { "group": [ { "link": { "href": "https://crowdserver/crowd/group?groupname=group&groupname=crowd-administrators", "rel": "self" }, "name": "crowd-administrators" } ] }
POST

Search

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

Request

Query parameters

entity-type

string

Required
max-results

integer

start-index

integer

Request bodyapplication/json application/xml

restriction entities must satisfy

restriction-type

string

Required

Responses

list of users or groups is retrieved

application/json application/xml

any

POST/rest/usermanagement/1/search
1 2 3 4 5 6 7 8 9 10 11 12 13 curl --request POST \ --url 'http://{baseurl}/rest/rest/usermanagement/1/search?entity-type={entity-type}' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "restriction-type": "property-search-restriction", "property": { "name": "email", "type": "STRING" }, "matchMode": "EXACTLY_MATCHES", "value": "bob@example.net" }'
200Response
1 2 3 4 5 6 7 8 9 10 11 { "group": [ { "link": { "href": "https://crowdserver/crowd/group?groupname=group&groupname=crowd-administrators", "rel": "self" }, "name": "crowd-administrators" } ] }

Rate this page: