Skip to main content
POST
/
group
Get List (POST)
curl --request POST \
  --url http://{host}:{port}/{contextPath}/group \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Sales"
}'
[
  {
    "id": "sales",
    "name": "Sales",
    "type": "Organizational Unit"
  }
]

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
firstResult
integer

Pagination of results. Specifies the index of the first result to return.

​
maxResults
integer

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Body

application/json

A group instance query which defines a list of group instances

​
id
string | null

Filter by the id of the group.

​
idIn
string[] | null

Filter by a JSON string array of group ids.

​
name
string | null

Filter by the name of the group.

​
nameLike
string | null

Filter by the name that the parameter is a substring of.

​
type
string | null

Filter by the type of the group.

​
member
string | null

Only retrieve groups where the given user id is a member of.

​
memberOfTenant
string | null

Only retrieve groups which are members of the given tenant.

​
sorting
object[] | null

Apply sorting of the result

Response

Request successful.

​
id
string | null

The id of the group.

​
name
string | null

The name of the group.

​
type
string | null

The type of the group.