Skip to main content

List all portal users​

Returns a list of all portal users according to supplied query parameters.

Query Parameters
  • limit number

    Possible values: >= 1 and <= 100

    Default value: 100

    Specifies the maximum number of results to be returned by the server.

  • offset number

    Possible values: <= 1000000

    Specifies how many results to skip. Used in conjunction with limit to achieve pagination.

  • search string

    Possible values: non-empty and <= 256 characters

    Search string to filter portal users by. Applies to multiple portal user properties such as email, first name, and last name.

  • domainId string
  • roleIds

    Filter portal users by role IDs.

Responses

Returns all portal users matching search/filters criteria.

Schema array
  • id uuid

    Id of the portal user.

  • createdTimestamp date-time

    When the user was created, specified in ISO 8601.

  • enabled boolean

    Sets a user to active if true or inactive if false.

  • firstName string

    First name of the portal user.

  • lastName string

    Last name of the portal user.

  • email string

    Possible values: >= 5 characters and <= 254 characters

    The email address of the portal user.

  • phoneNumber string

    Possible values: >= 4 characters and <= 20 characters

    The phone number of the portal user.

  • domainId string

    Hierarchical identifier for a domain. Used to identify which domain a user belongs to and whether a user has access to a domain.

  • roles object[]

    Contains list of roles.

  • id uuid

    Identifies the role.

  • name string

    Name of the role.

  • description string

    Description of the role.

  • domain object

    Contains domain properties.

  • id uuid

    Id of the domain in Keycloak. Only used in this API, not to be confused with domainId.

  • name string

    Name of the domain.

Loading...