Update IDP Principal.

put

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

Update the specified IDP Principal

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

sid

string

required

Specifies the SID of the IDP Principal.

Body Params

Specifies the parameters to update IDP Principal.

allowDsoModify

boolean | null

Defaults to false

Specifies whether the data security user has consented to modification by admin users. Only a user with the Data Security role can set this field to true. This must be set to true before an admin can modify or remove the Data Security role from this user.

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

effectiveTimeUsecs

int64 | null

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

expiredTimeUsecs

int64 | null

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

idpId

int64 | null

required

Specifies the IDP of the IDP with which this principal is associated.

idpType

string | null

enum

Specifies the type of this Idp. It can be 'SAML' or 'OIDC'. In case if this field is not specified then idpType 'SAML' is assumed.

Allowed:

isActive

boolean | null

Specifies whether or not this principal is currently active.

name

string | null

required

Specifies the name of the Principal.

principalType

string | null

enum

required

Specifies the type of this principal. It can be a 'User' or a 'Group'.

Allowed:

profiles

array of objects

Specifies the list of tenant profiles associated to this principal if any.

profiles

roles

array of strings

Specifies a list of roles associated with this Principal.

roles

tenantAccesses

array of objects

Specifies the list of tenant access associated to this principal.

tenantAccesses

Responses

200Success

defaultError