Search for Groups in the System¶

Retrieve list of groups¶

GET /api/v1/search/groups/¶

List the groups known in the system. It must be noted that a request could be rejected if the search criteria used would match too much possibilities

Example request:

GET /api/v1/search/groups/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "sensitiveGroupNameContains": "Test"
}

Request JSON Object:

sensitiveGroupIdStarts (string) – See sensitiveGroupIdStarts from Search criteria.
sensitiveGroupIdContains (string) – See sensitiveGroupIdContains from Search criteria.
sensitiveGroupIdEquals (string) – See sensitiveGroupIdEquals from Search criteria.
insensitiveGroupIdStarts (string) – See insensitiveGroupIdStarts from Search criteria.
insensitiveGroupIdContains (string) – See insensitiveGroupIdContains from Search criteria.
insensitiveGroupIdEquals (string) – See insensitiveGroupIdEquals from Search criteria.
sensitiveGroupNameStarts (string) – See sensitiveGroupNameStarts from Search criteria.
sensitiveGroupNameContains (string) – See sensitiveGroupNameContains from Search criteria.
sensitiveGroupNameEquals (string) – See sensitiveGroupNameEquals from Search criteria.
insensitiveGroupNameStarts (string) – See insensitiveGroupNameStarts from Search criteria.
insensitiveGroupNameContains (string) – See insensitiveGroupNameContains from Search criteria.
insensitiveGroupNameEquals (string) – See insensitiveGroupNameEquals from Search criteria.
sensitiveTenantIdEquals (string) – See sensitiveTenantIdEquals from Search criteria.
responseSizeLimit (integer) – See responseSizeLimit from Search criteria.
backendName (string) – See backendName from Search criteria.
backendExternalName (string) – See backendExternalName from Search criteria.

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "groups": [
      {
         "groupId": "foogroup",
         "groupName": "Foo Test Group",
         "userLimit": 10,
         "tenantId": "foo"
      }
   ]
}

Response JSON Object:

groups (object) – a list of group object defined as Group basic attributes. For getting more details about a specific group, please refer to Retrieve group details.

Status Codes:

200 OK – no error

The behaviour of the search API is controlled by the following configuration settings:

"MULTI_AS_BACKEND_IN_SYSTEM_SEARCH_RESULTS": true

Explanation of the parameters:

MULTI_AS_BACKEND_IN_SYSTEM_SEARCH_RESULTS: if true, the backendName and backendExternal name of the AS hosting the group will be added in each element of the answer. The default value is true as by default a multi-as user is allowed to see what backend is used.