Support for Server products ended Feb. 15, 2024. Learn what this means for you.

Server

Crowd Data Center / / REST API

Search

Postman Collection

OpenAPI

Operations

GET/rest/usermanagement/1/search POST/rest/usermanagement/1/search

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

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://{baseurl}/rest/rest/usermanagement/1/search?entity-type={entity-type}' \
  --header 'Accept: application/json'

200Response

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

curl

Node.js

Java

Python

PHP

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

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