Jump to

• Request
• Response

Retrieve users in a group

get

/ic/api/process/v1/identities/groups/{groupid}/users

Retrieves user details of a group by group ID

Request

Path Parameters

• groupid(required): string
  The value of the group ID

Query Parameters

• email: string
  Email of the identity to search
• firstname: string
  First name of the user to search
• includeDirectReporteesFlag: boolean
  If true details of the direct reportees will be returned, if false- not, default is true

  Default Value: true
• includeManagerFlag: boolean
  If true details of the user's manager name will be returned, if false- not, default is true

  Default Value: true
• lastname: string
  Last name of the user to search
• searchPattern: string
  User pattern to search for, for example searchPattern=*b*

  Default Value: *
• totalResults: boolean
  Total Result - true or false

  Default Value: true

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : Collection

Type: object

400 Response

Bad request

401 Response

Unauthorized

404 Response

Users not found for group ID

500 Response

Internal Server Error

Back to Top