Update User information.

put

https://cluster.ip.address/v2/users/{sid}

No Privileges Required

Update an existing user on the Cohesity Cluster. Only user settings on the Cohesity Cluster are updated. No changes are made to the referenced user principal on the Active Directory/IdP.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

sid

string

required

Specify the SID of the user.

Body Params

Specifies the user information.

description

string | null

Specifies the description of the User.

effectiveTimeMsecs

int64 | null

Specifies the epoch time in milliseconds since when the user can login.

expiryTimeMsecs

int64 | null

Specifies the epoch time in milliseconds when the user expires. Post expiry the user cannot access Cohesity cluster.

locked

boolean | null

Specifies whether the User is locked.

restricted

boolean | null

Specifies whether the User is restricted. A restricted user can only view & manage the objects it has permissions to.

roles

array of strings | null

Specifies the Cohesity roles to associate with the user. The Cohesity roles determine privileges on the Cohesity Cluster for this user.

roles

localUserParams

object

Specifies properties for LOCAL cohesity user.

username

string | null

Specifies the username.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

defaultError