Sign in
Users

Create a user

Creates a user in the current customer account. Use this endpoint to add users programmatically, assign roles, and set up access permissions.

post/v2/users

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.

Request body

emailstring email required

The email address for the user.

usernamestring

The username for the user. The value defaults to the email.

descriptionstring

The description of the user.

api_rolesApiRole[]

The customer-level role names assigned to the user.

metadataobject

Arbitrary metadata associated with the user. The JSON serialization must not exceed 65535 bytes; larger payloads are rejected with a 400 response.

Example request

{
  "metadata": {
    "console_mode": "business"
  }
}

Response

The response returns a user object that contains the assigned user ID, email, username, enabled status, description, creation timestamp, and assigned API roles.

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.

metadataobject

Arbitrary metadata associated with the user.

one_time_codestring

A one-time code the new user uses to create a password. This is optional, and is only populated for some platform deployments.

one_time_code_linkstring

The link where the user enters the one_time_code. This is optional, and is only populated for some platform deployments.

Example response

{
  "metadata": {
    "console_mode": "business"
  }
}

Changes

Changed in 2 of the 13 revisions of this API.24

  • c94fd099d78b13See the full diff
    • ●

      added the new metrics_viewer enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new metrics_viewer enum value to the request property /

      request-property-enum-value-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

  • fca567a46b3a11See the full diff
    • ●

      added the new agent_end_user enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ○

      added the new agent_end_user enum value to the request property //

      request-property-enum-value-added