List Users

GET

/iam/v1/users

curl --request GET \
  --url https://example.com/iam/v1/users

Returns a paginated list of users

Parameters

Query Parameters

page_size

integer format: int32

The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 20 users will be returned. The maximum value is 100; values above 100 will be coerced to 100.

page_token

string

A page token, received from a previous ListUsers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUsers must match the call that provided the page token.

filter

string

AIP-160 filter expression, e.g. ‘is_active = true’

order_by

string

AIP-132 order_by expression, e.g. ‘email asc’

Responses

200

OK

Media type application/json

ListUsersResponse

Response message for ListUsers. Note: This API intentionally omits total_size from list responses. Keyset pagination does not support efficient total count computation (COUNT(*) requires a full table scan). Per AIP-158, total_size is optional.

object

users

The list of users

Array<object>

User resource — an authenticated human identity in the platform (a Person).

object

id

The unique identifier of the user

stringOutput only

email

required

The email address of the user

string

name

required

The given name of the user

string

surname

required

The family name of the user

string

avatar

Reference to the user’s avatar image in object storage; empty when unset.

string

status

The lifecycle status of the user.

string format: enum Output only

Allowed values: PRINCIPAL_STATUS_UNSPECIFIED PRINCIPAL_STATUS_INVITED PRINCIPAL_STATUS_ACTIVE PRINCIPAL_STATUS_DEACTIVATED

type

The discriminated principal kind (always USER for this resource).

string format: enum Output only

Allowed values: PRINCIPAL_TYPE_UNSPECIFIED PRINCIPAL_TYPE_USER PRINCIPAL_TYPE_SERVICE_ACCOUNT

last_seen

Best-effort last-authentication instant; absent until first authentication.

string format: date-time Output only

created

Created Timestamp

The timestamp when the user was created

string format: date-time Output only

updated

Updated Timestamp

Timestamp when the User was last updated

string format: date-time Output only

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is empty, there are no subsequent pages.

string

Example

{
  "users": [
    {
      "status": "PRINCIPAL_STATUS_UNSPECIFIED",
      "type": "PRINCIPAL_TYPE_UNSPECIFIED"
    }
  ]
}

default

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32

message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}