Get Users (v2.0)

GET 
/v2.0/api/tenants/:tenant_id/users

List all the users.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

id string

The ID.

tenant_id string

The tenant ID.

items UserIdentity[]
Array [
disabled boolean
List the users in a disabled state.
disabled_reason string
List the reason for the disabled state.
first_name string
The first name of the user. Max size = 100.
id string
The ID.
inactive boolean
Lists if the user is inactive.
inactive_reason string
Reason the user is inactive.
last_name string
The last name of the user.
middle_name string
The middle name of the user.
region string
The region.
tenant_id stringrequired
ID of the tenant.
user_dn string
The user dn.
user_fqn string
The user fqn.
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "tenant_id": "string",
  "items": [
    {
      "disabled": true,
      "disabled_reason": "string",
      "first_name": "string",
      "id": "string",
      "inactive": true,
      "inactive_reason": "string",
      "last_name": "string",
      "middle_name": "string",
      "region": "string",
      "tenant_id": "string",
      "user_dn": "string",
      "user_fqn": "string"
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_JSON"
      }
    ]
  }
}

Loading...