Create or add a new user to the Cohesity Cluster.

post

https://cluster.ip.address/irisservices/api/v1/public/users

Privileges: PRINCIPAL_MODIFY

If an Active Directory domain is specified, a new user is added to the
Cohesity Cluster for the specified Active Directory user principal.
If the LOCAL domain is specified, a new user is created directly in
the default LOCAL domain on the Cohesity Cluster.

Returns the created or added user.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to add or create a new user.

Specifies the settings used to create/add a new user or modify an
existing user.

additionalGroupNames

array of strings | null

Array of Additional Groups.

Specifies the names of additional groups this User may belong to.

additionalGroupNames

clusterIdentifiers

array of objects | null

Specifies the list of clusters this user has access to. If this is not
specified, access will be granted to all clusters.

clusterIdentifiers

description

string | null

Specifies a description about the user.

domain

string | null

Specifies the fully qualified domain name (FQDN) of an Active Directory
or LOCAL for the default LOCAL domain on the Cohesity Cluster.
A user is uniquely identified by combination of the username and
the domain.

effectiveTimeMsecs

int64 | null

Specifies the epoch time in milliseconds when the user becomes
effective. Until that time, the user cannot log in.

emailAddress

string | null

Specifies the email address of the user.

expiredTimeMsecs

int64 | null

Specifies the epoch time in milliseconds when the user becomes
expired. After that, the user cannot log in.

password

string | null

Specifies the password of this user.

primaryGroupName

string | null

Specifies the name of the primary group of this User.

privilegeIds

array of strings | null

Array of Privileges.

Specifies the Cohesity privileges from the roles. This will be populated
based on the union of all privileges in roles.
Type for unique privilege Id values.
All below enum values specify a value for all uniquely defined
privileges in Cohesity.

privilegeIds

profiles

array of objects | null

Specifies the user profiles.
NOTE: Currently used for Helios.

profiles

restricted

boolean | null

Whether the user is a restricted user. A restricted user can only view
the objects he has permissions to.

roles

array of strings | null

Array of Roles.

Specifies the Cohesity roles to associate with the user such as
such as 'Admin', 'Ops' or 'View'.
The Cohesity roles determine privileges on the Cohesity Cluster
for this user.

roles

tenantAccesses

array of objects | null

Specifies the tenant access available to current user.
NOTE: Currently used for Helios.

tenantAccesses

username

string | null

Specifies the login name of the user.

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