Cohesity

Cohesity Principals API

The Principals API from Cohesity — 10 operation(s) for principals.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 17

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /public/principals/protectionSources See which sources and views principals can access · Returns the Protection Sources objects and View names that the principals have… #
Ask an LLM
“Which protection sources and views can a given user or group access?”
“Can I check access for several SIDs in one request?”
Tell an agent
List the protection sources and views that principal {sids} can access.
Show what objects and views SIDs {sids} have permission to see.
PUT /public/principals/protectionSources Grant principals access to sources and views · Set the Protection Sources and Views that the specified principal has… #
Ask an LLM
“How do I give an Active Directory group access to specific VMs and views?”
“Can I restrict a user to only certain protection sources?”
Tell an agent
Set source and view access for principals as {sourcesForPrincipals}.
Grant these principals access to the listed protection sources and views: {sourcesForPrincipals}.
GET /public/principals/searchPrincipals Search users and groups in a domain · List the user and group principals that match the filter criteria specified… #
Ask an LLM
“Can I find Active Directory users or groups whose names contain a substring?”
“Is it possible to include computer or GMSA accounts in a principal search?”
Tell an agent
Search domain {domain} for principals matching {search}.
Find groups in {domain} whose name contains {search}.
GET /public/sessionUser Get the logged-in user · Get the information of the logged in user #
Ask an LLM
“Who am I logged in as on the Cohesity cluster?”
“What roles and domain does my current session user have?”
Tell an agent
Show the user I'm currently logged in as.
Get my session user's details.
GET /public/users List cluster users · List the users on the Cohesity Cluster that match the filter criteria specified… #
Ask an LLM
“Which users have accounts on my cluster?”
“Can I find a user by email address or a partial username?”
Tell an agent
List users whose username contains {usernames}.
Find the cluster user with email {emailAddresses}.
PUT /public/users Update a cluster user's settings · Update an existing user on the Cohesity Cluster. #
Ask an LLM
“How do I change a user's roles on the cluster without touching Active Directory?”
“Can I force a local user to change their password at next login?”
Tell an agent
Update user {username} in {domain} to have roles {roles}.
Force user {username} to change their password.
POST /public/users Add a user to the cluster · Create or add a new user to the Cohesity Cluster #
Ask an LLM
“How do I add an Active Directory user to my Cohesity cluster?”
“Can I create a local user with an expiry date?”
Tell an agent
Create local user {username} with email {emailAddress} and roles {roles}.
Add AD user {username} from domain {domain} to the cluster.
DELETE /public/users Delete users from the cluster · Delete one or more users on the Cohesity Cluster #
Ask an LLM
“Does removing a user from the cluster also delete them in Active Directory?”
“Can I delete several users from the same domain in one go?”
Tell an agent destructive · confirm first
Delete users {users} from domain {domain}.
Remove cluster user accounts {users}.
GET /public/users/privileges List my session user's privileges · List the privileges of the session user #
Ask an LLM
“What privileges does my current login actually have?”
“Am I allowed to manage protection jobs with my account's privileges?”
Tell an agent
List the privileges of my session user.
Show what I'm allowed to do on this cluster.
POST /public/users/s3SecretKey Reset a user's S3 secret key · Reset the S3 secret access key for the specified user on the Cohesity Cluster #
Ask an LLM
“How do I rotate the S3 secret access key for a cluster user?”
“Will resetting the S3 secret key break apps using the old one?”
Tell an agent destructive · confirm first
Reset the S3 secret key for user {username}.
Generate a new S3 secret key for {username} in {domain}.
GET /public/users/{sid}/apiKeys List a user's API keys · Fetch API keys for user #
Ask an LLM
“Which API keys does a particular user have?”
“Can I filter a user's API keys by key id?”
Tell an agent
List the API keys for user {sid}.
Show API keys {ids} belonging to user {sid}.
POST /public/users/{sid}/apiKeys Create an API key for a user · Create an API key for user #
Ask an LLM
“How do I generate an API key for a service account user?”
“Can I give a new API key an expiration time?”
Tell an agent
Create API key {name} for user {sid}.
Create API key {name} for user {sid} that expires at {expiringTimeMsecs}.
GET /public/users/{sid}/apiKeys/{id} Get one of a user's API keys · Fetch an API key for user by its id #
Ask an LLM
“Is a specific API key of a user still active and when does it expire?”
“Can I look up a single user API key by its id?”
Tell an agent
Get API key {id} for user {sid}.
Show the details of user {sid}'s key {id}.
PUT /public/users/{sid}/apiKeys/{id} Update a user's API key · Update an API key #
Ask an LLM
“Can I deactivate an API key without deleting it?”
“How do I extend an API key's expiration?”
Tell an agent
Deactivate API key {id} for user {sid}.
Rename user {sid}'s API key {id} to {name}.
DELETE /public/users/{sid}/apiKeys/{id} Delete a user's API key · Delete an API key for user #
Ask an LLM
“How do I permanently remove an API key a user no longer needs?”
“What happens to clients still using an API key after it is deleted?”
Tell an agent destructive · confirm first
Delete API key {id} of user {sid}.
Remove user {sid}'s key {id} for good.
POST /public/users/{sid}/apiKeys/{id}/rotate Rotate a user's API key · Fetch an API key for user by its id #
Ask an LLM
“Can I rotate an API key to get a fresh secret while keeping the same key entry?”
“What does rotating a user API key return?”
Tell an agent
Rotate API key {id} for user {sid}.
Rotate the secret of user {sid}'s key {id}.
GET /public/usersApiKeys List API keys across all users · Fetch API keys across all users #
Ask an LLM
“Which API keys exist across every user on the cluster?”
“Can I audit API keys for a handful of users at once?”
Tell an agent
List API keys across all users.
Show the API keys owned by users {userSids}.

Documentation

📖
Documentation
https://developer.cohesity.com/helios-api.html
📖
GettingStarted
https://developer.cohesity.com/docs/helios-getting-started
📖
APIReference
https://developer.cohesity.com/apidocs/versions/
📖
Documentation
https://developer.cohesity.com/apidocs/versions/
📖
APIReference
https://developers.cohesity.com/page/api-reference
📖
GettingStarted
https://developers.cohesity.com/docs/getting-started
📖
Documentation
https://developer.cohesity.com/apidocs/helios-reporting
📖
Documentation
https://developer.cohesity.com/apidocs/site-continuity

Specifications

⚙
OpenAPI
https://artifacts.apis.io/cohesity/openapi/cohesity-principals-api-openapi.yml

Other Resources

🔗
Postman
https://api.cohesity.com/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cohesity:cohesity-principals-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cohesity-principals-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: 'This API list provides operations for interfacing with the Cohesity

    Cluster.'
  title: Cohesity REST Principals API
  version: '1.0'
servers:
- url: https://<CLUSTER_VIP>/irisservices/api/v1
tags:


# --- truncated at 32 KB (354 KB total) ---
# Full source: https://artifacts.apis.io/cohesity/openapi/cohesity-principals-api-openapi.yml