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. Filterable fields: create_time, email, id, last_seen_time, name, status, surname, update_time.

order_by

string

AIP-132 order_by expression. Sortable fields: create_time, email, last_seen_time, name, status, surname, update_time.

skip

string

AIP-158 offset mode: number of resources to skip from the start of the filtered, sorted set. Use EITHER skip (offset paging) OR page_token (cursor paging) — never both in the same request. Supplying both is an invalid request. Default 0 (no skip).

scope_type

string

The scope the caller is acting at: ORGANISATION, WORKSPACE, or GROUP.

Supplied, the caller is authorized at that scope, so whoever administers one organisation or workspace can list the people in it. Omitted, the request resolves at the platform scope — exactly today’s behaviour.

scope_id

string

The unique identifier of the scope. Supplied together with scope_type.

Responses

200

OK

Media type application/json

ListUsersResponse

Response message for ListUsers.

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

An opaque marker that changes whenever the user’s avatar changes; empty when the user has none.

It is NOT a URL and NOT resolvable by a client — the image lives in a private platform bucket. Read the bytes from the avatar sub-resource instead. Treat this only as a cache key: equal means unchanged, different means refetch.

Server-assigned: the avatar is replaced through its own sub-resource, so a value sent here is ignored rather than stored.

stringOutput only

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_time

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

string format: date-time Output only

create_time

Created Timestamp

The timestamp when the user was created

string format: date-time Output only

update_time

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

total_size

Exact count of resources matching the request’s filter and scope (both pagination modes).

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"
    }
  ]
}