Teams
Use these operations to interact with teams in Cortex.
This page lists operations specific to team entities. See Catalog entities for API operations relating to all entity types (including teams).
Required permissions
Your API key must have the Edit entities permission.
Operations
Warning: This API can return team details if you pass in a teamTag query parameter. However, this should only be used to retrieve team details if your team identifier contains non-alphanumeric characters. Otherwise, use the standard API under Teams -> Retrieve team details. When retrieving team details, the response will be a single team entity instead of a list.
Note: the response objects can also include an idpGroup or cortexTeam field depending on whether the team contains a group or only consists of individually defined members.
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Include teams without members
falseTeam identifier
my-teamObject containing a list of teams
Team not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.
Successfully found team
Note: the response objects can also include an idpGroup or cortexTeam field depending on whether the team contains a group or only consists of individually defined members.
Team not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
Team memberships can be backed by an IdP group (from Okta, Azure AD, Google Groups, etc), or can be managed directly through Cortex. Each has a separate request shape, so make sure to select the correct example.
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Successfully created a team
Bad Request
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
For teams whose members are not backed by an IdP, use this API to update the team members. Note that it will replace the members in the team with the members defined in this request.
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.
Successfully updated team members
Bad Request
Forbidden
Team not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
For teams whose members are not backed by an IdP, use this API to update the team members. Note that it will replace the members in the team with the members defined in this request. Warning: This API should only be used if your team identifier contains non-alphanumeric characters. Otherwise, use the standard API under Teams.
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Successfully updated team members
Bad Request
Forbidden
Team not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
Warning: This API should only be used if your team identifier contains non-alphanumeric characters. Otherwise, use the standard API under Teams.
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Successfully updated team
Bad Request
Team not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.
Successfully updated team
Bad Request
Team not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.
Successfully archived team
Team not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.
Successfully unarchived team
Team not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Successfully deleted team
Team not found
Team delete is not allowed
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.
Successfully deleted team
Team not found
Team delete is not allowed
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
Last updated
Was this helpful?