Skip to main content

Search Users By Email

GET 

/users/search

This operation allows to get a page of User by email

Request

Query Parameters

    email string

    user email

    limit int32

    Default value: 20

    Limit of the page

    offset int32

    Default value: 0

    Offset of the page

Responses

ok

Response Headers

  • X-Total-Count

    integer

    total count of users

  • X-Result-Count

    integer

    users result count

Schema

  • Array [

  • id uuid

    Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

    user uuid

    identityName string

    user identity name

    displayName string

    user displayed name

    email string

    user email

    firstName string

    user first name

    lastName string

    user last name

    organizations

    object[]

    list of organization roles associated to a user

  • Array [

  • organizationId uuid

    Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

    organization UUID associated to user

    organizationName string

    organization name associated to user

    roleId uuid

    Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

    role UUID associated to user

    roleName string

    role name associated to user

  • ]

  • ]

Loading...