Getting StartedAPI ReferenceRecipesGitHub
API Reference

Add one or more users to Cohesity Cluster.

post
https://example.com/v2/users

Add one or more users to Cohesity Cluster.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

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

S3AccessKeys
object

Specifies the S3 Access keys for a User.

boolean | null

Specifies whether the SMB access token is to be set for the user.

string | null

Specifies the description of the User.

string
required

Specifies the domain of the user. For active directories, this is the fully qualified domain name (FQDN). It is 'LOCAL' for local users on the Cohesity Cluster. A user is uniquely identified by combination of the username and the domain.

int64 | null

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

int64 | null

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

localUserParams
object

Specifies properties for LOCAL cohesity user.

boolean | null

Specifies whether the User is locked.

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
string
required

Specifies the username.

Responses

Updated 8 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago