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

Retrieve list of teams or team details

get

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.

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Query parameters

includeTeamsWithoutMembersbooleanOptional

Include teams without members

Example: false

teamTagstringOptional

Team identifier

Example: my-team

Responses

200

Object containing a list of teams

application/json

404

Team not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get

/api/v1/teams

HTTPcURLJavaScriptPython

GET /api/v1/teams HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "teams": [
    {
      "catalogEntityTag": "text",
      "id": "text",
      "isArchived": true,
      "links": [
        {
          "description": "text",
          "name": "text",
          "type": "text",
          "url": "text"
        }
      ],
      "metadata": {
        "description": "text",
        "name": "text",
        "summary": "text"
      },
      "slackChannels": [
        {
          "description": "text",
          "name": "text",
          "notificationsEnabled": true
        }
      ],
      "teamTag": "text",
      "type": "text",
      "cortexTeam": "[Circular Reference]"
    }
  ]
}

Retrieve team details

get

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Path parameters

tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Responses

200

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.

application/json

404

Team not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get

/api/v1/teams/{tagOrId}

HTTPcURLJavaScriptPython

GET /api/v1/teams/{tagOrId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "catalogEntityTag": "text",
  "id": "text",
  "isArchived": true,
  "links": [
    {
      "description": "text",
      "name": "text",
      "type": "text",
      "url": "text"
    }
  ],
  "metadata": {
    "description": "text",
    "name": "text",
    "summary": "text"
  },
  "slackChannels": [
    {
      "description": "text",
      "name": "text",
      "notificationsEnabled": true
    }
  ],
  "teamTag": "text",
  "type": "text",
  "cortexTeam": "[Circular Reference]"
}

Create a team

post

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.

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Body

application/json

or

Responses

200

Successfully created a team

application/json

400

Bad Request

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

post

/api/v1/teams

HTTPcURLJavaScriptPython

POST /api/v1/teams HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 290

{
  "links": [
    {
      "description": "text",
      "name": "text",
      "type": "text",
      "url": "text"
    }
  ],
  "metadata": {
    "description": "text",
    "name": "text",
    "summary": "text"
  },
  "slackChannels": [
    {
      "description": "text",
      "name": "text",
      "notificationsEnabled": true
    }
  ],
  "teamTag": "text",
  "type": "text",
  "cortexTeam": "[Circular Reference]"
}

{
  "catalogEntityTag": "text",
  "id": "text",
  "isArchived": true,
  "links": [
    {
      "description": "text",
      "name": "text",
      "type": "text",
      "url": "text"
    }
  ],
  "metadata": {
    "description": "text",
    "name": "text",
    "summary": "text"
  },
  "slackChannels": [
    {
      "description": "text",
      "name": "text",
      "notificationsEnabled": true
    }
  ],
  "teamTag": "text",
  "type": "text",
  "cortexTeam": "[Circular Reference]"
}

[Cortex managed teams] Update members in team

put

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.

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Path parameters

tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Body

application/json

typestringRequired

Responses

200

Successfully updated team members

application/json

400

Bad Request

application/json

403

Forbidden

application/json

404

Team not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

put

/api/v1/teams/{tagOrId}/members

HTTPcURLJavaScriptPython

PUT /api/v1/teams/{tagOrId}/members HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "members": [
    {
      "description": "text",
      "email": "text",
      "name": "text",
      "notificationsEnabled": true,
      "roleTags": [
        "text"
      ]
    }
  ],
  "type": "text"
}

{
  "catalogEntityTag": "text",
  "id": "text",
  "isArchived": true,
  "links": [
    {
      "description": "text",
      "name": "text",
      "type": "text",
      "url": "text"
    }
  ],
  "metadata": {
    "description": "text",
    "name": "text",
    "summary": "text"
  },
  "slackChannels": [
    {
      "description": "text",
      "name": "text",
      "notificationsEnabled": true
    }
  ],
  "teamTag": "text",
  "type": "text",
  "cortexTeam": "[Circular Reference]"
}

[Cortex managed teams] Update members in team

put

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.

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Query parameters

teamTagstringRequired

Body

application/json

typestringRequired

Responses

200

Successfully updated team members

application/json

400

Bad Request

application/json

403

Forbidden

application/json

404

Team not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

put

/api/v1/teams/members

HTTPcURLJavaScriptPython

PUT /api/v1/teams/members?teamTag=text HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "members": [
    {
      "description": "text",
      "email": "text",
      "name": "text",
      "notificationsEnabled": true,
      "roleTags": [
        "text"
      ]
    }
  ],
  "type": "text"
}

{
  "catalogEntityTag": "text",
  "id": "text",
  "isArchived": true,
  "links": [
    {
      "description": "text",
      "name": "text",
      "type": "text",
      "url": "text"
    }
  ],
  "metadata": {
    "description": "text",
    "name": "text",
    "summary": "text"
  },
  "slackChannels": [
    {
      "description": "text",
      "name": "text",
      "notificationsEnabled": true
    }
  ],
  "teamTag": "text",
  "type": "text",
  "cortexTeam": "[Circular Reference]"
}

Update team metadata

put

Warning: This API should only be used if your team identifier contains non-alphanumeric characters. Otherwise, use the standard API under Teams.

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Query parameters

teamTagstringRequired

Body

application/json

or

Responses

200

Successfully updated team

application/json

400

Bad Request

application/json

404

Team not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

put

/api/v1/teams

HTTPcURLJavaScriptPython

PUT /api/v1/teams?teamTag=text HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 273

{
  "links": [
    {
      "description": "text",
      "name": "text",
      "type": "text",
      "url": "text"
    }
  ],
  "metadata": {
    "description": "text",
    "name": "text",
    "summary": "text"
  },
  "slackChannels": [
    {
      "description": "text",
      "name": "text",
      "notificationsEnabled": true
    }
  ],
  "type": "text",
  "cortexTeam": "[Circular Reference]"
}

{
  "catalogEntityTag": "text",
  "id": "text",
  "isArchived": true,
  "links": [
    {
      "description": "text",
      "name": "text",
      "type": "text",
      "url": "text"
    }
  ],
  "metadata": {
    "description": "text",
    "name": "text",
    "summary": "text"
  },
  "slackChannels": [
    {
      "description": "text",
      "name": "text",
      "notificationsEnabled": true
    }
  ],
  "teamTag": "text",
  "type": "text",
  "cortexTeam": "[Circular Reference]"
}

Update team metadata

put

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Path parameters

tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Body

application/json

or

Responses

200

Successfully updated team

application/json

400

Bad Request

application/json

404

Team not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

put

/api/v1/teams/{tagOrId}

HTTPcURLJavaScriptPython

PUT /api/v1/teams/{tagOrId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 273

{
  "links": [
    {
      "description": "text",
      "name": "text",
      "type": "text",
      "url": "text"
    }
  ],
  "metadata": {
    "description": "text",
    "name": "text",
    "summary": "text"
  },
  "slackChannels": [
    {
      "description": "text",
      "name": "text",
      "notificationsEnabled": true
    }
  ],
  "type": "text",
  "cortexTeam": "[Circular Reference]"
}

{
  "catalogEntityTag": "text",
  "id": "text",
  "isArchived": true,
  "links": [
    {
      "description": "text",
      "name": "text",
      "type": "text",
      "url": "text"
    }
  ],
  "metadata": {
    "description": "text",
    "name": "text",
    "summary": "text"
  },
  "slackChannels": [
    {
      "description": "text",
      "name": "text",
      "notificationsEnabled": true
    }
  ],
  "teamTag": "text",
  "type": "text",
  "cortexTeam": "[Circular Reference]"
}

Archive team

put

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Path parameters

tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Responses

200

Successfully archived team

application/json

404

Team not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

put

/api/v1/teams/{tagOrId}/archive

HTTPcURLJavaScriptPython

PUT /api/v1/teams/{tagOrId}/archive HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "catalogEntityTag": "text",
  "id": "text",
  "isArchived": true,
  "links": [
    {
      "description": "text",
      "name": "text",
      "type": "text",
      "url": "text"
    }
  ],
  "metadata": {
    "description": "text",
    "name": "text",
    "summary": "text"
  },
  "slackChannels": [
    {
      "description": "text",
      "name": "text",
      "notificationsEnabled": true
    }
  ],
  "teamTag": "text",
  "type": "text",
  "cortexTeam": "[Circular Reference]"
}

Unarchive team

put

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Path parameters

tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Responses

200

Successfully unarchived team

application/json

404

Team not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

put

/api/v1/teams/{tagOrId}/unarchive

HTTPcURLJavaScriptPython

PUT /api/v1/teams/{tagOrId}/unarchive HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "catalogEntityTag": "text",
  "id": "text",
  "isArchived": true,
  "links": [
    {
      "description": "text",
      "name": "text",
      "type": "text",
      "url": "text"
    }
  ],
  "metadata": {
    "description": "text",
    "name": "text",
    "summary": "text"
  },
  "slackChannels": [
    {
      "description": "text",
      "name": "text",
      "notificationsEnabled": true
    }
  ],
  "teamTag": "text",
  "type": "text",
  "cortexTeam": "[Circular Reference]"
}

Delete team

delete

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Query parameters

teamTagstringRequired

Responses

204

Successfully deleted team

application/json

404

Team not found

application/json

405

Team delete is not allowed

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

delete

/api/v1/teams

HTTPcURLJavaScriptPython

DELETE /api/v1/teams?teamTag=text HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

Delete team by tag or ID

delete

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Path parameters

tagOrIdstringRequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Responses

204

Successfully deleted team

application/json

404

Team not found

application/json

405

Team delete is not allowed

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

delete

/api/v1/teams/{tagOrId}

HTTPcURLJavaScriptPython

DELETE /api/v1/teams/{tagOrId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}