List Users

GET

/api/v1/permissions/users

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

List all users in the account.

Returns: UserListResponse with list of users

Raises: HTTPException: If listing users fails

Parameters

Header Parameters

X-Environment-Id

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

UserListResponse

Response containing list of users.

object

users

required

Users

List of users

Array<object>

UserInfo

Information about a user.

object

name

required

Name

User name

string

owner

required

Owner

User owner

string

login_name

Any of:

string

string

null

null

display_name

Any of:

string

string

null

null

first_name

Any of:

string

string

null

null

last_name

Any of:

string

string

null

null

email

Any of:

string

string

null

null

disabled

Disabled

Whether user is disabled

boolean

created_on

Any of:

string

string format: date-time

null

null

total_count

required

Total Count

Total number of users

integer

Example

{
  "users": [
    {
      "disabled": false
    }
  ]
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}