Get Users (v2.0)

List all the users.

Path Parameters

tenant_id string required

The tenant ID.

Responses

• 200
• 400

---

Successful Operation

application/json

Schema

Example (from schema)

---

Schema

count int32

The number of responses.

id string

The ID of the response.

tenant_id string

The ID of the tenant.

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 string required
Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)
user_dn string
The user dn.
user_fqn string
The user fqn.
]

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

Bad Request

application/json

Schema

Example (from schema)

Example

---

Schema

_error ErrorResponse[]
Array [
code string
message string
]

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

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

Loading...