Skip to main content
PUT
Error

Authorizations

x-cdata-authtoken
string
header
required

Path Parameters

User
string
required

The key User

Body

application/json

The users entity to update.

User
string
required

The name of the user.

UserId
string

The id of the user.

EmailAddress
string

The email address of the user.

Password
string

The password to authenticate with. Write-only; masked on read.

FederationId
string

The federation id for SSO authentication.

Roles
string

The assigned roles of the user, by name.

Active
string

Whether the user is active or not. Defaults to true.

Authtoken
string

The primary authtoken of the user. Masked on read.

ExpiresIn
string

The number of days until the auth token expires; -1 means never.

ExpiresAt
integer<int64>

The auth token expiration timestamp, or null if it never expires.

Type
string

The account kind: 'standard' or 'service'.

ClientId
string

The OAuth client id.

MFAStatus
string

Whether MFA is enabled for the user.

ExpirationTime
integer<int64>

The expiration time for a temporary account, as a unix timestamp.

ResetPassword
string

Whether the user must reset the password on next login.

TrustedIPs
string

The whitelist of IP addresses.

BlockedIPs
string

The blacklist of IP addresses.

Response

EntitySet users

User
string
required

The name of the user.

UserId
string

The id of the user.

EmailAddress
string

The email address of the user.

Password
string

The password to authenticate with. Write-only; masked on read.

FederationId
string

The federation id for SSO authentication.

Roles
string

The assigned roles of the user, by name.

Active
string

Whether the user is active or not. Defaults to true.

Authtoken
string

The primary authtoken of the user. Masked on read.

ExpiresIn
string

The number of days until the auth token expires; -1 means never.

ExpiresAt
integer<int64>

The auth token expiration timestamp, or null if it never expires.

Type
string

The account kind: 'standard' or 'service'.

ClientId
string

The OAuth client id.

MFAStatus
string

Whether MFA is enabled for the user.

ExpirationTime
integer<int64>

The expiration time for a temporary account, as a unix timestamp.

ResetPassword
string

Whether the user must reset the password on next login.

TrustedIPs
string

The whitelist of IP addresses.

BlockedIPs
string

The blacklist of IP addresses.