List Users

GET

/api/v1/auth/users

curl --request GET \
  --url https://example.com/api/v1/auth/users \
  --header 'Authorization: Bearer <token>'

Lists the Users. It requires a signed-in User with the admin scope and the admin or owner Role. It can return 401 if the session is missing or expired, 403 if access is denied and 429 if the request limit is reached. Route: /api/v1/auth/users. Inputs: . Safe reads can use bounded retries.

Authorizations

• installationBearer
• browserSession

Responses

200

Media typeapplication/json

Array<object>

Admin view of a User. It has no credential or session material.

object

created_at

required

integer format: int64

deletion_pending

required

True while the server drains the durable Home deletion action.

boolean

disabled

required

boolean

display_name

required

string

id

required

string format: uuid

quota_override_bytes

None inherits the Instance default; Some(0) means unlimited.

integer | null format: int64

role

required

string

Allowed values: owner admin member guest

username

required

string

Example

[
  {
    "role": "owner"
  }
]

429

Too many requests

Media typeapplication/json

object

code

required

string

message

required

string

Example^generated

{
  "code": "example",
  "message": "example"
}