Create a principal on helios.

post

https://helios.cohesity.com/v2/mcm/principals

Create a principal on helios. Note: This api is only supported in Multi-Cluster Manager (MCM).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body params to create a principal

principalType

string

enum

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

Allowed:

objectClass

string

enum

required

Specifies the type of principal, a user or a group

Allowed:

name

string

required

Specifies the name of the principal which is being added.

string | null

Specifies the email address of the principal.

roles

array of strings

Specifies the role assigned to the principal.

roles

description

string | null

Specifies the desciption of the principal.

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.

lastUpdatedTimeUsecs

int64 | null

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

effectiveTimeUsecs

int64 | null

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

activeDirectoryParams

object | null

Specifies the params of Active Directory.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

201Success

defaultError