Retrieve team details

GET 
/api/v1/teams/:teamTag

Retrieve team details

Request

Path Parameters

teamTag stringrequired

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

Schema

Schema

catalogEntityTag stringrequired
isArchived booleanrequired

links

object[]

required

Array [

description string

name stringrequired

type stringrequired

url stringrequired

]

metadata

object

required

description string

name stringrequired

summary string

slackChannels

object[]

required

Array [

channel stringrequired

The Slack channel identifier without the preceding #

description string

Description of this owner defined in the Catalog Descriptor. Not to be confused with the description of the team in the Team pages.

inheritance string

Possible values: [APPEND, FALLBACK, NONE]

Inheritance type, only defined for domain entities

notificationsEnabled boolean

Refers to the corresponding field in the Catalog Descriptor. This is meant to be used for your automation purposes and does not actually impact the notification behavior in Cortex.

]

teamTag stringrequired

Example (from schema)

{
  "catalogEntityTag": "string",
  "isArchived": true,
  "links": [
    {
      "description": "string",
      "name": "string",
      "type": "string",
      "url": "string"
    }
  ],
  "metadata": {
    "description": "string",
    "name": "string",
    "summary": "string"
  },
  "slackChannels": [
    {
      "channel": "string",
      "description": "string",
      "inheritance": "APPEND",
      "notificationsEnabled": true
    }
  ],
  "teamTag": "string",
  "type": "string"
}

404

Team not found

application/json

Schema

Schema

details string
gatewayHttpStatus int32
httpStatus int32
message stringrequired
requestId string
type stringrequired

Possible values: [INTEGRATION_MISSING, INTEGRATION_UNREGISTERED, INTEGRATION_UNSUPPORTED, INTEGRATION_GRAPHQL_ERROR, INTEGRATION_BAD_REQUEST, INTEGRATION_UNAUTHORIZED, INTEGRATION_FORBIDDEN, INTEGRATION_NOT_FOUND, INTEGRATION_UNPROCESSABLE_CONTENT, INTEGRATION_RATE_LIMITED, INTEGRATION_INTERNAL_ERROR, INTEGRATION_NOT_IMPLEMENTED, INTEGRATION_BAD_GATEWAY, INTEGRATION_UNAVAILABLE, INTEGRATION_GATEWAY_TIMEOUT, INTEGRATION_TIMED_OUT, INTEGRATION_CACHE_ERROR, INTEGRATION_UNHANDLED_HTTP_ERROR, INTEGRATION_UNHANDLED_EXCEPTION, INTEGRATION_UNEXPECTED_ERROR, ILLEGAL_ARGUMENT_ERROR, BAD_REQUEST, FORBIDDEN, NOT_FOUND, REQUEST_TIMEOUT, CONFLICT, UNHANDLED_EXCEPTION, UNCATEGORIZED, SERVICE_CREATOR, UNKNOWN_HOST]

Example (from schema)

{
  "details": "string",
  "gatewayHttpStatus": 0,
  "httpStatus": 0,
  "message": "string",
  "requestId": "string",
  "type": "INTEGRATION_MISSING"
}

Loading...