Sign in
Groups

Search for users in a group

Changed on
get/api/v1/{tenant}/groups/{id}/members

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/{tenant}/groups/{id}/members
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Path parameters

idstring required

The group id

tenantstring required

Query parameters

pageinteger required

The current page

sizeinteger required

The current page size

sortstring[] nullable

The sort of current page

field'QUERY' | 'SCOPE' | 'NAMESPACE' | 'KIND' | 'LABELS' | 'METADATA' | 'FLOW_ID' | 'FLOW_REVISION' | 'ID' | 'ASSET_ID' | 'TYPE' | 'CREATED' | 'UPDATED' | 'START_DATE' | 'END_DATE' | 'EXPIRATION_DATE' | 'STATE' | 'TIME_RANGE' | 'TRIGGER_EXECUTION_ID' | 'TRIGGER_ID' | 'TRIGGER_STATE' | 'EXECUTION_ID' | 'TASK_ID' | 'TASK_RUN_ID' | 'CHILD_FILTER' | 'WORKER_ID' | 'EXISTING_ONLY' | 'MIN_LEVEL' | 'PATH' | 'PARENT_PATH' | 'VERSION' | 'USERNAME'
operation'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'LESS_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN_OR_EQUAL_TO' | 'IN' | 'NOT_IN' | 'STARTS_WITH' | 'ENDS_WITH' | 'CONTAINS' | 'REGEX' | 'PREFIX'
valueobject

Filters

Response

searchGroupMembers 200 response

totalinteger required

Example response

{
  "total": 0,
  "results": [
    {
      "displayName": "displayName",
      "groups": [
        {
          "external": true,
          "name": "name",
          "id": "id",
          "membership": "OWNER"
        },
        {
          "external": true,
          "name": "name",
          "id": "id",
          "membership": "OWNER"
        }
      ],
      "id": "id",
      "username": "username"
    },
    {
      "displayName": "displayName",
      "groups": [
        {
          "external": true,
          "name": "name",
          "id": "id",
          "membership": "OWNER"
        },
        {
          "external": true,
          "name": "name",
          "id": "id",
          "membership": "OWNER"
        }
      ],
      "id": "id",
      "username": "username"
    }
  ]
}

Changes

  • b6097dbc46aeRevision changes
    • breaking

      added the new required query request parameter filters

    • warning

      deleted the query request parameter q