Sign in

v2

OpenAPI 3.0.02026-08-051996591.2 MB
Users

Get a user

Returns a user with details such as the email, username, and associated roles.

get/v2/users/{username}

Path parameters

usernamestring required

The username of the user to return. The username must be percent encoded.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

A user.

idstring required

The Vectara ID for the user.

emailstring email required

The email address for the user.

usernamestring

The username for the user.

enabledboolean

Indicates whether the user is enabled or disabled.

descriptionstring

The description of the user.

created_atstring date-time

When the user was created.

updated_atstring date-time

When a user property was last updated.

api_rolesApiRole[]

The customer-level role names of the user.