Skip to main content

Identity_ListUsers​

Identity_ListUsers

Query Parameters
  • pageSize int32

    If unspecified, server will pick an appropriate default.

  • pageToken string

    The value returned from the previous call.

  • filter string

    A filter to be applied to results.

Responses

OK

Schema
  • users object[]

    The list of users.

    • name string

      The resource name of the user.

    • uuid string

      The uuid that identifies the user during the authentication flow.

    • username string

      The public username of the user.

    • discriminator string

      The public discriminator of the user.

    • primaryEmail string

      The primary email address of the user.

    • primaryEmailVerified boolean

      Whether the primary email address has been verified.

    • givenName string

      The given name of the user.

    • familyName string

      The family name of the user.

    • displayName string

      The name of the user.

    • countryCode string

      The country where the user is located at, must be a valid ISO-3166 code.

    • locale string

      The locale preferred by the user, must be a valid BCP-47 code.

    • localeFallback string

      The fallback locale preferred by the user, must be a valid BCP-47 code. The only allowed values are eng, jpn, and jpn-Latn (romaji).

    • birthday date

      The birthday defined by the user, this value is used to determine whether the user should be allowed to access explicit and sensitive content.

    • gender enum

      Possible values: [GENDER_UNSPECIFIED, MALE, FEMALE, OTHER]

      The gender of the user.

    • profileImage string

      The profile image of the user.

    • bannerImage string

      The banner image of the user.

  • nextPageToken string

    A token to retrieve next page of results.