Update a specified principal.

put

https://helios.cohesity.com/v2/mcm/principals/{sid}

Update a specified principal. Note: This api is only supported in Multi-Cluster Manager (MCM).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

sid

string

required

Specifies the SID of the Principal.

Body Params

Request body params to update the principal

activeDirectoryParams

object | null

Specifies the params of Active Directory.

clusters

array of strings

Specifies a list of clusters associated with this Principal. They should be in a string with the format '{cluster ID}:{cluster incarnation ID}'.

clusters

createdTimeUsecs

int64 | null

Specifies the timestamp in microseconds since the epoch when this Principal was created.

description

string | null

Specifies the desciption of the principal.

effectiveTimeUsecs

int64 | null

Specifies the starting timestamp in microseconds since the epoch when this principal will be able to log in.

string | null

Specifies the email address of the principal.

lastUpdatedTimeUsecs

int64 | null

Specifies the timestamp in microseconds since the epoch when this Principal was updated.

name

string

required

Specifies the name of the principal which is being added.

objectClass

string

enum

required

Specifies the type of principal, a user or a group

Allowed:

principalType

string

enum

required

Specifies the type of principal, a local, an sso or an active directory.

Allowed:

roles

array of strings

Specifies the role assigned to the principal.

roles

Responses

200Success

defaultError