Skip to main content
PUT
Error

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

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.

FederationId
string

The federation id for SSO authentication.

Roles
string

The assigned roles of the user.

Active
string

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

Authtoken
string

The primary authtoken of the user.

ExpiredIn
string

The days of auth token expired, defaults to -1 never expired.

RowVersion
integer<int64>

The version number of user information.

LicenseState
string

Whether the user is valid or invalid based on the license.

LicenseMessage
string

Details for why the user is invalid.

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.

FederationId
string

The federation id for SSO authentication.

Roles
string

The assigned roles of the user.

Active
string

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

Authtoken
string

The primary authtoken of the user.

ExpiredIn
string

The days of auth token expired, defaults to -1 never expired.

RowVersion
integer<int64>

The version number of user information.

LicenseState
string

Whether the user is valid or invalid based on the license.

LicenseMessage
string

Details for why the user is invalid.