Skip to main content

Get a list of Identities assigned a Role

Get a list of Identities assigned a Role

Path Parameters
  • id string required

    ID of the Role for which the assigned Identities are to be listed

    Example: 2c91808a7813090a017814121e121518
Query Parameters
  • limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
  • offset int32

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

  • count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true
  • filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    id: eq, in

    aliasName: eq, sw

    email: eq, sw

    name: eq, sw, co

    Example: name sw Joe
  • sorters comma-separated

    Sort results using the standard syntax described in V3 API Standard Collection Parameters

    Sorting is supported for the following fields: id, name, aliasName, email

    Example: aliasName,name
Responses

List of Identities assigned the Role


Schema array
  • id string

    The ID of the Identity

  • aliasName string

    The alias / username of the Identity

  • name string

    The human-readable display name of the Identity

  • email string

    Email address of the Identity

  • roleAssignmentSource string

    Possible values: [ACCESS_REQUEST, ROLE_MEMBERSHIP]

    Type which indicates how a particular Identity obtained a particular Role

Loading...