Teams

Use these operations to interact with teams in Cortex.

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

Query parameters

includeTeamsWithoutMembersbooleanoptional

Include teams without members

Example: false

teamTagstringoptional

Team identifier

Example: my-team

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/teams' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

{
  "teams": [
    {
      "catalogEntityTag": "text",
      "cortexTeam": {
        "members": [
          {
            "description": "text",
            "email": "text",
            "name": "text",
            "notificationsEnabled": true,
            "role": {
              "source": "text",
              "tag": "text",
              "type": "text"
            },
            "roles": [
              {
                "source": "text",
                "tag": "text",
                "type": "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"
    }
  ]
}

Object containing a list of teams

Retrieve team details

get

Authorizations

Path parameters

tagOrIdstringrequired

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

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/teams/{tagOrId}' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

{
  "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": {
    "members": [
      {
        "description": "text",
        "email": "text",
        "name": "text",
        "notificationsEnabled": true,
        "role": {
          "source": "text",
          "tag": "text",
          "type": "text"
        },
        "roles": [
          {
            "source": "text",
            "tag": "text",
            "type": "text"
          }
        ]
      }
    ]
  }
}

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.

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

Body

linksobject[]required

metadataobjectrequired

slackChannelsobject[]required

teamTagstringrequired

typestringrequired

Use "IDP" for IdentityProviderBackedTeam and "CORTEX" for ManagedTeam

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/teams' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "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": {
      "members": [
        {
          "description": "text",
          "email": "text",
          "name": "text",
          "notificationsEnabled": true,
          "role": {
            "source": "text",
            "tag": "text",
            "type": "text"
          },
          "roles": [
            {
              "source": "text",
              "tag": "text",
              "type": "text"
            }
          ]
        }
      ]
    }
  }'

200

400

429

200

{
  "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": {
    "members": [
      {
        "description": "text",
        "email": "text",
        "name": "text",
        "notificationsEnabled": true,
        "role": {
          "source": "text",
          "tag": "text",
          "type": "text"
        },
        "roles": [
          {
            "source": "text",
            "tag": "text",
            "type": "text"
          }
        ]
      }
    ]
  }
}

Successfully created a team

[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

Path parameters

tagOrIdstringrequired

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

Body

membersobject[]required

typestringrequired

Responses

application/json

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/teams/{tagOrId}/members' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "members": [
      {
        "description": "text",
        "email": "text",
        "name": "text",
        "notificationsEnabled": true,
        "roleTags": [
          "text"
        ]
      }
    ],
    "type": "text"
  }'

200

400

403

404

429

200

{
  "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": {
    "members": [
      {
        "description": "text",
        "email": "text",
        "name": "text",
        "notificationsEnabled": true,
        "role": {
          "source": "text",
          "tag": "text",
          "type": "text"
        },
        "roles": [
          {
            "source": "text",
            "tag": "text",
            "type": "text"
          }
        ]
      }
    ]
  }
}

Successfully updated team members

[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

Query parameters

teamTagstringrequired

Body

membersobject[]required

typestringrequired

Responses

application/json

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/teams/members?teamTag=text' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "members": [
      {
        "description": "text",
        "email": "text",
        "name": "text",
        "notificationsEnabled": true,
        "roleTags": [
          "text"
        ]
      }
    ],
    "type": "text"
  }'

200

400

403

404

429

200

{
  "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": {
    "members": [
      {
        "description": "text",
        "email": "text",
        "name": "text",
        "notificationsEnabled": true,
        "role": {
          "source": "text",
          "tag": "text",
          "type": "text"
        },
        "roles": [
          {
            "source": "text",
            "tag": "text",
            "type": "text"
          }
        ]
      }
    ]
  }
}

Successfully updated team members

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

Query parameters

teamTagstringrequired

Body

linksobject[]required

metadataobjectrequired

slackChannelsobject[]required

typestringrequired

Use "IDP" for IdentityProviderBackedTeam and "CORTEX" for ManagedTeam

Responses

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/teams?teamTag=text' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "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": {
      "members": [
        {
          "description": "text",
          "email": "text",
          "name": "text",
          "notificationsEnabled": true,
          "role": {
            "source": "text",
            "tag": "text",
            "type": "text"
          },
          "roles": [
            {
              "source": "text",
              "tag": "text",
              "type": "text"
            }
          ]
        }
      ]
    }
  }'

200

400

404

429

200

{
  "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": {
    "members": [
      {
        "description": "text",
        "email": "text",
        "name": "text",
        "notificationsEnabled": true,
        "role": {
          "source": "text",
          "tag": "text",
          "type": "text"
        },
        "roles": [
          {
            "source": "text",
            "tag": "text",
            "type": "text"
          }
        ]
      }
    ]
  }
}

Successfully updated team

Update team metadata

put

Authorizations

Path parameters

tagOrIdstringrequired

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

Body

linksobject[]required

metadataobjectrequired

slackChannelsobject[]required

typestringrequired

Use "IDP" for IdentityProviderBackedTeam and "CORTEX" for ManagedTeam

Responses

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/teams/{tagOrId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "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": {
      "members": [
        {
          "description": "text",
          "email": "text",
          "name": "text",
          "notificationsEnabled": true,
          "role": {
            "source": "text",
            "tag": "text",
            "type": "text"
          },
          "roles": [
            {
              "source": "text",
              "tag": "text",
              "type": "text"
            }
          ]
        }
      ]
    }
  }'

200

400

404

429

200

{
  "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": {
    "members": [
      {
        "description": "text",
        "email": "text",
        "name": "text",
        "notificationsEnabled": true,
        "role": {
          "source": "text",
          "tag": "text",
          "type": "text"
        },
        "roles": [
          {
            "source": "text",
            "tag": "text",
            "type": "text"
          }
        ]
      }
    ]
  }
}

Successfully updated team

Archive team

put

Authorizations

Path parameters

tagOrIdstringrequired

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

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/teams/{tagOrId}/archive' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

{
  "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": {
    "members": [
      {
        "description": "text",
        "email": "text",
        "name": "text",
        "notificationsEnabled": true,
        "role": {
          "source": "text",
          "tag": "text",
          "type": "text"
        },
        "roles": [
          {
            "source": "text",
            "tag": "text",
            "type": "text"
          }
        ]
      }
    ]
  }
}

Successfully archived team

Unarchive team

put

Authorizations

Path parameters

tagOrIdstringrequired

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

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/teams/{tagOrId}/unarchive' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

{
  "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": {
    "members": [
      {
        "description": "text",
        "email": "text",
        "name": "text",
        "notificationsEnabled": true,
        "role": {
          "source": "text",
          "tag": "text",
          "type": "text"
        },
        "roles": [
          {
            "source": "text",
            "tag": "text",
            "type": "text"
          }
        ]
      }
    ]
  }
}

Successfully unarchived team

Delete team

delete

Authorizations

Query parameters

teamTagstringrequired

Responses

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/teams?teamTag=text' \
  --header 'Authorization: Bearer JWT'

204

404

405

429

204

{}

Successfully deleted team

Delete team by tag or ID

delete

Authorizations

Path parameters

tagOrIdstringrequired

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

Responses

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/teams/{tagOrId}' \
  --header 'Authorization: Bearer JWT'

204

404

405

429

204

{}

Successfully deleted team