diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 1a9592b48a332..9346226be7c8f 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -10994,6 +10994,49 @@ menu: unstable: - v2 order: 2 + - name: Team Connections + url: /api/latest/team-connections/ + identifier: team-connections + generated: true + - name: Create team connections + url: '#create-team-connections' + identifier: team-connections-create-team-connections + parent: team-connections + generated: true + params: + versions: + - v2 + operationids: + - CreateTeamConnections + unstable: + - v2 + order: 2 + - name: List team connections + url: '#list-team-connections' + identifier: team-connections-list-team-connections + parent: team-connections + generated: true + params: + versions: + - v2 + operationids: + - ListTeamConnections + unstable: + - v2 + order: 1 + - name: Delete team connections + url: '#delete-team-connections' + identifier: team-connections-delete-team-connections + parent: team-connections + generated: true + params: + versions: + - v2 + operationids: + - DeleteTeamConnections + unstable: + - v2 + order: 3 - name: Teams url: /api/latest/teams/ identifier: teams diff --git a/content/en/api/latest/team-connections/_index.md b/content/en/api/latest/team-connections/_index.md new file mode 100644 index 0000000000000..ff0fe3ed06e30 --- /dev/null +++ b/content/en/api/latest/team-connections/_index.md @@ -0,0 +1,3 @@ +--- +title: Team Connections +--- diff --git a/content/en/api/v2/team-connections/_index.md b/content/en/api/v2/team-connections/_index.md new file mode 100644 index 0000000000000..04673b01a2a29 --- /dev/null +++ b/content/en/api/v2/team-connections/_index.md @@ -0,0 +1,4 @@ +--- +title: Team Connections +headless: true +--- diff --git a/content/en/api/v2/team-connections/examples.json b/content/en/api/v2/team-connections/examples.json new file mode 100644 index 0000000000000..323cf347b66d5 --- /dev/null +++ b/content/en/api/v2/team-connections/examples.json @@ -0,0 +1,257 @@ +{ + "DeleteTeamConnections": { + "responses": { + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": [ + { + "id": "12345678-1234-5678-9abc-123456789012", + "type": "team_connection" + } + ] + }, + "json": { + "data": [ + { + "id": "12345678-1234-5678-9abc-123456789012", + "type": "team_connection" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Array of team connection IDs to delete.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team connection to delete.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team connection resource type. \nAllowed enum values: team_connection

default: team_connection

\n
\n \n
\n
\n
\n
" + } + }, + "ListTeamConnections": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "managed_by": "github_sync", + "source": "github" + }, + "id": "12345678-1234-5678-9abc-123456789012", + "relationships": { + "connected_team": { + "data": { + "id": "@GitHubOrg/team-handle", + "type": "github_team" + } + }, + "team": { + "data": { + "id": "87654321-4321-8765-dcba-210987654321", + "type": "team" + } + } + }, + "type": "team_connection" + } + ], + "meta": { + "page": { + "first_number": "integer", + "last_number": "integer", + "next_number": "integer", + "number": "integer", + "prev_number": "integer", + "size": "integer", + "total": "integer", + "type": "number_size" + } + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of team connections.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the team connection.

\n
\n
\n
\n
\n
\n

managed_by

\n
\n

string

\n

The entity that manages this team connection.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

string

\n

The name of the external source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team connection.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the team connection.

\n
\n
\n
\n
\n
\n

connected_team

\n
\n

object

\n

Reference to a team from an external system.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Reference to connected external team.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The connected team ID as it is referenced throughout the Datadog ecosystem.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

External team resource type. \nAllowed enum values: github_team

default: github_team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Reference to a Datadog team.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Reference to a Datadog team.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The Datadog team ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Datadog team resource type. \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team connection resource type. \nAllowed enum values: team_connection

default: team_connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Connections response metadata.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Page-based pagination metadata.

\n
\n
\n
\n
\n
\n

first_number

\n
\n

int64

\n

The first page number.

\n
\n \n
\n
\n
\n
\n
\n

last_number

\n
\n

int64

\n

The last page number.

\n
\n \n
\n
\n
\n
\n
\n

next_number

\n
\n

int64

\n

The next page number.

\n
\n \n
\n
\n
\n
\n
\n

number

\n
\n

int64

\n

The current page number.

\n
\n \n
\n
\n
\n
\n
\n

prev_number

\n
\n

int64

\n

The previous page number.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The page size.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total connections matching request.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Pagination type.

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateTeamConnections": { + "responses": { + "201": { + "json": { + "data": [ + { + "attributes": { + "managed_by": "github_sync", + "source": "github" + }, + "id": "12345678-1234-5678-9abc-123456789012", + "relationships": { + "connected_team": { + "data": { + "id": "@GitHubOrg/team-handle", + "type": "github_team" + } + }, + "team": { + "data": { + "id": "87654321-4321-8765-dcba-210987654321", + "type": "team" + } + } + }, + "type": "team_connection" + } + ], + "meta": { + "page": { + "first_number": "integer", + "last_number": "integer", + "next_number": "integer", + "number": "integer", + "prev_number": "integer", + "size": "integer", + "total": "integer", + "type": "number_size" + } + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of team connections.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the team connection.

\n
\n
\n
\n
\n
\n

managed_by

\n
\n

string

\n

The entity that manages this team connection.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

string

\n

The name of the external source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the team connection.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the team connection.

\n
\n
\n
\n
\n
\n

connected_team

\n
\n

object

\n

Reference to a team from an external system.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Reference to connected external team.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The connected team ID as it is referenced throughout the Datadog ecosystem.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

External team resource type. \nAllowed enum values: github_team

default: github_team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Reference to a Datadog team.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Reference to a Datadog team.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The Datadog team ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Datadog team resource type. \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team connection resource type. \nAllowed enum values: team_connection

default: team_connection

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Connections response metadata.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Page-based pagination metadata.

\n
\n
\n
\n
\n
\n

first_number

\n
\n

int64

\n

The first page number.

\n
\n \n
\n
\n
\n
\n
\n

last_number

\n
\n

int64

\n

The last page number.

\n
\n \n
\n
\n
\n
\n
\n

next_number

\n
\n

int64

\n

The next page number.

\n
\n \n
\n
\n
\n
\n
\n

number

\n
\n

int64

\n

The current page number.

\n
\n \n
\n
\n
\n
\n
\n

prev_number

\n
\n

int64

\n

The previous page number.

\n
\n \n
\n
\n
\n
\n
\n

size

\n
\n

int64

\n

The page size.

\n
\n \n
\n
\n
\n
\n
\n

total

\n
\n

int64

\n

Total connections matching request.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Pagination type.

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "409": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": [ + { + "relationships": { + "connected_team": { + "data": { + "id": "@GitHubOrg/team-handle", + "type": "github_team" + } + }, + "team": { + "data": { + "id": "87654321-4321-8765-dcba-210987654321", + "type": "team" + } + } + }, + "type": "team_connection" + } + ] + }, + "json": { + "data": [ + { + "attributes": { + "managed_by": "github_sync", + "source": "github" + }, + "relationships": { + "connected_team": { + "data": { + "id": "@GitHubOrg/team-handle", + "type": "github_team" + } + }, + "team": { + "data": { + "id": "87654321-4321-8765-dcba-210987654321", + "type": "team" + } + } + }, + "type": "team_connection" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Array of team connections to create.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the team connection.

\n
\n
\n
\n
\n
\n

managed_by

\n
\n

string

\n

The entity that manages this team connection.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

string

\n

The name of the external source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the team connection.

\n
\n
\n
\n
\n
\n

connected_team

\n
\n

object

\n

Reference to a team from an external system.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Reference to connected external team.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The connected team ID as it is referenced throughout the Datadog ecosystem.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

External team resource type. \nAllowed enum values: github_team

default: github_team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

team

\n
\n

object

\n

Reference to a Datadog team.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Reference to a Datadog team.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The Datadog team ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Datadog team resource type. \nAllowed enum values: team

default: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Team connection resource type. \nAllowed enum values: team_connection

default: team_connection

\n
\n \n
\n
\n
\n
" + } + } +} \ No newline at end of file diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 75a0747a801a7..461ab57f0bdb3 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -11514,6 +11514,35 @@ components: $ref: '#/components/schemas/ConfluentResourceResponseData' type: array type: object + ConnectedTeamRef: + description: Reference to a team from an external system. + properties: + data: + $ref: '#/components/schemas/ConnectedTeamRefData' + type: object + ConnectedTeamRefData: + description: Reference to connected external team. + properties: + id: + description: The connected team ID as it is referenced throughout the Datadog + ecosystem. + example: '@GitHubOrg/team-handle' + type: string + type: + $ref: '#/components/schemas/ConnectedTeamRefDataType' + required: + - id + - type + type: object + ConnectedTeamRefDataType: + default: github_team + description: External team resource type. + enum: + - github_team + example: github_team + type: string + x-enum-varnames: + - GITHUB_TEAM Connection: description: The definition of `Connection` object. properties: @@ -11578,6 +11607,50 @@ components: - label - tags type: object + ConnectionsPagePagination: + description: Page-based pagination metadata. + properties: + first_number: + description: The first page number. + format: int64 + type: integer + last_number: + description: The last page number. + format: int64 + type: integer + next_number: + description: The next page number. + format: int64 + nullable: true + type: integer + number: + description: The current page number. + format: int64 + type: integer + prev_number: + description: The previous page number. + format: int64 + nullable: true + type: integer + size: + description: The page size. + format: int64 + type: integer + total: + description: Total connections matching request. + format: int64 + type: integer + type: + description: Pagination type. + example: number_size + type: string + type: object + ConnectionsResponseMeta: + description: Connections response metadata. + properties: + page: + $ref: '#/components/schemas/ConnectionsPagePagination' + type: object Container: description: Container object. properties: @@ -51778,6 +51851,111 @@ components: - handle - name type: object + TeamConnection: + description: A relationship between a Datadog team and a team from another external + system. + properties: + attributes: + $ref: '#/components/schemas/TeamConnectionAttributes' + id: + description: The unique identifier of the team connection. + example: 12345678-1234-5678-9abc-123456789012 + type: string + relationships: + $ref: '#/components/schemas/TeamConnectionRelationships' + type: + $ref: '#/components/schemas/TeamConnectionType' + required: + - id + - type + type: object + TeamConnectionAttributes: + description: Attributes of the team connection. + properties: + managed_by: + description: The entity that manages this team connection. + example: github_sync + type: string + source: + description: The name of the external source. + example: github + type: string + type: object + TeamConnectionCreateData: + description: Data for creating a team connection. + properties: + attributes: + $ref: '#/components/schemas/TeamConnectionAttributes' + relationships: + $ref: '#/components/schemas/TeamConnectionRelationships' + type: + $ref: '#/components/schemas/TeamConnectionType' + required: + - type + type: object + TeamConnectionCreateRequest: + description: Request for creating team connections. + properties: + data: + description: Array of team connections to create. + items: + $ref: '#/components/schemas/TeamConnectionCreateData' + type: array + required: + - data + type: object + TeamConnectionDeleteRequest: + description: Request for deleting team connections. + properties: + data: + description: Array of team connection IDs to delete. + items: + $ref: '#/components/schemas/TeamConnectionDeleteRequestDataItem' + type: array + required: + - data + type: object + TeamConnectionDeleteRequestDataItem: + description: A collection of connection ids to delete. + properties: + id: + description: The unique identifier of the team connection to delete. + example: 12345678-1234-5678-9abc-123456789012 + type: string + type: + $ref: '#/components/schemas/TeamConnectionType' + required: + - id + - type + type: object + TeamConnectionRelationships: + description: Relationships of the team connection. + properties: + connected_team: + $ref: '#/components/schemas/ConnectedTeamRef' + team: + $ref: '#/components/schemas/TeamRef' + type: object + TeamConnectionType: + default: team_connection + description: Team connection resource type. + enum: + - team_connection + example: team_connection + type: string + x-enum-varnames: + - TEAM_CONNECTION + TeamConnectionsResponse: + description: Response containing information about multiple team connections. + properties: + data: + description: Array of team connections. + items: + $ref: '#/components/schemas/TeamConnection' + type: array + meta: + $ref: '#/components/schemas/ConnectionsResponseMeta' + type: object TeamCreate: description: Team create properties: @@ -52195,6 +52373,34 @@ components: $ref: '#/components/schemas/TeamPermissionSetting' type: array type: object + TeamRef: + description: Reference to a Datadog team. + properties: + data: + $ref: '#/components/schemas/TeamRefData' + type: object + TeamRefData: + description: Reference to a Datadog team. + properties: + id: + description: The Datadog team ID. + example: 87654321-4321-8765-dcba-210987654321 + type: string + type: + $ref: '#/components/schemas/TeamRefDataType' + required: + - id + - type + type: object + TeamRefDataType: + default: team + description: Datadog team resource type. + enum: + - team + example: team + type: string + x-enum-varnames: + - TEAM TeamReference: description: Provides a reference to a team, including ID, type, and basic attributes/relationships. properties: @@ -82650,6 +82856,169 @@ paths: permissions: - teams_read - teams_manage + /api/v2/team/connections: + delete: + description: Delete multiple team connections. + operationId: DeleteTeamConnections + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TeamConnectionDeleteRequest' + required: true + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read + summary: Delete team connections + tags: + - Team Connections + x-menu-order: 3 + x-permission: + operator: OR + permissions: + - teams_read + x-unstable: '**Note**: This endpoint is in Preview. To request access, fill + out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/). + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + get: + description: Returns all team connections. + operationId: ListTeamConnections + parameters: + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/PageNumber' + - description: Filter team connections by external source systems. + explode: false + in: query + name: filter[sources] + required: false + schema: + items: + example: github + type: string + type: array + style: form + - description: Filter team connections by Datadog team IDs. + explode: false + in: query + name: filter[team_ids] + required: false + schema: + items: + example: 12345678-1234-5678-9abc-123456789012 + type: string + type: array + style: form + - description: Filter team connections by connected team IDs from external systems. + explode: false + in: query + name: filter[connected_team_ids] + required: false + schema: + items: + example: '@MyGitHubAccount/my-team-name' + type: string + type: array + style: form + - description: Filter team connections by connection IDs. + explode: false + in: query + name: filter[connection_ids] + required: false + schema: + items: + example: 12345678-1234-5678-9abc-123456789012 + type: string + type: array + style: form + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TeamConnectionsResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read + summary: List team connections + tags: + - Team Connections + x-menu-order: 1 + x-pagination: + limitParam: page[size] + pageParam: page[number] + resultsPath: data + x-permission: + operator: OR + permissions: + - teams_read + x-unstable: '**Note**: This endpoint is in Preview. To request access, fill + out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/). + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + post: + description: Create multiple team connections. + operationId: CreateTeamConnections + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TeamConnectionCreateRequest' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/TeamConnectionsResponse' + description: Created + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '409': + $ref: '#/components/responses/ConflictResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read + summary: Create team connections + tags: + - Team Connections + x-menu-order: 2 + x-permission: + operator: OR + permissions: + - teams_read + x-unstable: '**Note**: This endpoint is in Preview. To request access, fill + out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/). + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/v2/team/sync: post: description: 'This endpoint attempts to link your existing Datadog teams with @@ -85947,6 +86316,9 @@ tags: use Datadog\u2019s API to\nmanage both test types programmatically.\n\nFor more information about Synthetics, see the [Synthetics overview](https://docs.datadoghq.com/synthetics/)." name: Synthetics +- description: View and manage relationships between Datadog teams and teams from + external sources, such as GitHub. + name: Team Connections - description: View and manage teams within Datadog. See the [Teams page](https://docs.datadoghq.com/account_management/teams/) for more information. name: Teams diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index 564eddc415e29..7031b899172e5 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -71405,6 +71405,78 @@ }, "type": "object" }, + "ConnectedTeamRef": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "ConnectedTeamRefData": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "ConnectedTeamRefDataType": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + }, "Connection": { "description": "The definition of `Connection` object.", "properties": { @@ -71546,6 +71618,108 @@ ], "type": "object" }, + "ConnectionsPagePagination": { + "description": "Page-based pagination metadata.", + "properties": { + "first_number": { + "description": "The first page number.", + "format": "int64", + "type": "integer" + }, + "last_number": { + "description": "The last page number.", + "format": "int64", + "type": "integer" + }, + "next_number": { + "description": "The next page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "number": { + "description": "The current page number.", + "format": "int64", + "type": "integer" + }, + "prev_number": { + "description": "The previous page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "size": { + "description": "The page size.", + "format": "int64", + "type": "integer" + }, + "total": { + "description": "Total connections matching request.", + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Pagination type.", + "example": "number_size", + "type": "string" + } + }, + "type": "object" + }, + "ConnectionsResponseMeta": { + "description": "Connections response metadata.", + "properties": { + "page": { + "description": "Page-based pagination metadata.", + "properties": { + "first_number": { + "description": "The first page number.", + "format": "int64", + "type": "integer" + }, + "last_number": { + "description": "The last page number.", + "format": "int64", + "type": "integer" + }, + "next_number": { + "description": "The next page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "number": { + "description": "The current page number.", + "format": "int64", + "type": "integer" + }, + "prev_number": { + "description": "The previous page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "size": { + "description": "The page size.", + "format": "int64", + "type": "integer" + }, + "total": { + "description": "Total connections matching request.", + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Pagination type.", + "example": "number_size", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "Container": { "description": "Container object.", "properties": { @@ -360771,6 +360945,698 @@ ], "type": "object" }, + "TeamConnection": { + "description": "A relationship between a Datadog team and a team from another external system.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier of the team connection.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "TeamConnectionAttributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "TeamConnectionCreateData": { + "description": "Data for creating a team connection.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "TeamConnectionCreateRequest": { + "description": "Request for creating team connections.", + "properties": { + "data": { + "description": "Array of team connections to create.", + "items": { + "description": "Data for creating a team connection.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "TeamConnectionDeleteRequest": { + "description": "Request for deleting team connections.", + "properties": { + "data": { + "description": "Array of team connection IDs to delete.", + "items": { + "description": "A collection of connection ids to delete.", + "properties": { + "id": { + "description": "The unique identifier of the team connection to delete.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "TeamConnectionDeleteRequestDataItem": { + "description": "A collection of connection ids to delete.", + "properties": { + "id": { + "description": "The unique identifier of the team connection to delete.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "TeamConnectionRelationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "TeamConnectionType": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + }, + "TeamConnectionsResponse": { + "description": "Response containing information about multiple team connections.", + "properties": { + "data": { + "description": "Array of team connections.", + "items": { + "description": "A relationship between a Datadog team and a team from another external system.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier of the team connection.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Connections response metadata.", + "properties": { + "page": { + "description": "Page-based pagination metadata.", + "properties": { + "first_number": { + "description": "The first page number.", + "format": "int64", + "type": "integer" + }, + "last_number": { + "description": "The last page number.", + "format": "int64", + "type": "integer" + }, + "next_number": { + "description": "The next page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "number": { + "description": "The current page number.", + "format": "int64", + "type": "integer" + }, + "prev_number": { + "description": "The previous page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "size": { + "description": "The page size.", + "format": "int64", + "type": "integer" + }, + "total": { + "description": "Total connections matching request.", + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Pagination type.", + "example": "number_size", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, "TeamCreate": { "description": "Team create", "properties": { @@ -363547,6 +364413,78 @@ }, "type": "object" }, + "TeamRef": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "TeamRefData": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "TeamRefDataType": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + }, "TeamReference": { "description": "Provides a reference to a team, including ID, type, and basic attributes/relationships.", "properties": { @@ -722326,403 +723264,1444 @@ } } }, - "description": "Too many requests" - } - }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "teams_read" - ] - } - ], - "summary": "Get all teams", - "tags": [ - "Teams" - ], - "x-menu-order": 1, - "x-pagination": { - "limitParam": "page[size]", - "pageParam": "page[number]", - "resultsPath": "data" - }, - "x-permission": { - "operator": "OR", - "permissions": [ - "teams_read" - ] - } - }, - "post": { - "description": "Create a new team.\nUser IDs passed through the `users` relationship field are added to the team.", - "operationId": "CreateTeam", - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "Request to create a team", - "properties": { - "data": { - "description": "Team create", - "properties": { - "attributes": { - "description": "Team creation attributes", - "properties": { - "avatar": { - "description": "Unicode representation of the avatar for the team, limited to a single grapheme", - "example": "🥑", - "nullable": true, - "type": "string" - }, - "banner": { - "description": "Banner selection for the team", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "description": { - "description": "Free-form markdown description/content for the team's homepage", - "type": "string" - }, - "handle": { - "description": "The team's identifier", - "example": "example-team", - "maxLength": 195, - "type": "string" - }, - "hidden_modules": { - "description": "Collection of hidden modules for the team", - "items": { - "description": "String identifier of the module", - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "The name of the team", - "example": "Example Team", - "maxLength": 200, - "type": "string" - }, - "visible_modules": { - "description": "Collection of visible modules for the team", - "items": { - "description": "String identifier of the module", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "handle", - "name" - ], - "type": "object" - }, - "relationships": { - "description": "Relationships formed with the team on creation", - "properties": { - "users": { - "description": "Relationship to users.", - "properties": { - "data": { - "description": "Relationships to user objects.", - "example": [], - "items": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "description": "Response with a team", - "properties": { - "data": { - "description": "A team", - "properties": { - "attributes": { - "description": "Team attributes", - "properties": { - "avatar": { - "description": "Unicode representation of the avatar for the team, limited to a single grapheme", - "example": "🥑", - "nullable": true, - "type": "string" - }, - "banner": { - "description": "Banner selection for the team", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "created_at": { - "description": "Creation date of the team", - "format": "date-time", - "type": "string" - }, - "description": { - "description": "Free-form markdown description/content for the team's homepage", - "nullable": true, - "type": "string" - }, - "handle": { - "description": "The team's identifier", - "example": "example-team", - "maxLength": 195, - "type": "string" - }, - "hidden_modules": { - "description": "Collection of hidden modules for the team", - "items": { - "description": "String identifier of the module", - "type": "string" - }, - "type": "array" - }, - "link_count": { - "description": "The number of links belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" - }, - "modified_at": { - "description": "Modification date of the team", - "format": "date-time", - "type": "string" - }, - "name": { - "description": "The name of the team", - "example": "Example Team", - "maxLength": 200, - "type": "string" - }, - "summary": { - "description": "A brief summary of the team, derived from the `description`", - "maxLength": 120, - "nullable": true, - "type": "string" - }, - "user_count": { - "description": "The number of users belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" - }, - "visible_modules": { - "description": "Collection of visible modules for the team", - "items": { - "description": "String identifier of the module", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "handle", - "name" - ], - "type": "object" - }, - "id": { - "description": "The team's identifier", - "example": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "relationships": { - "description": "Resources related to a team", - "properties": { - "team_links": { - "description": "Relationship between a team and a team link", - "properties": { - "data": { - "description": "Related team links", - "items": { - "description": "Relationship between a link and a team", - "properties": { - "id": { - "description": "The team link's identifier", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "type": { - "default": "team_links", - "description": "Team link type", - "enum": [ - "team_links" - ], - "example": "team_links", - "type": "string", - "x-enum-varnames": [ - "TEAM_LINKS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "type": "array" - }, - "links": { - "description": "Links attributes.", - "properties": { - "related": { - "description": "Related link.", - "example": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "user_team_permissions": { - "description": "Relationship between a user team permission and a team", - "properties": { - "data": { - "description": "Related user team permission data", - "properties": { - "id": { - "description": "The ID of the user team permission", - "example": "UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595", - "type": "string" - }, - "type": { - "default": "user_team_permissions", - "description": "User team permission type", - "enum": [ - "user_team_permissions" - ], - "example": "user_team_permissions", - "type": "string", - "x-enum-varnames": [ - "USER_TEAM_PERMISSIONS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "links": { - "description": "Links attributes.", - "properties": { - "related": { - "description": "Related link.", - "example": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "CREATED" + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "teams_read" + ] + } + ], + "summary": "Get all teams", + "tags": [ + "Teams" + ], + "x-menu-order": 1, + "x-pagination": { + "limitParam": "page[size]", + "pageParam": "page[number]", + "resultsPath": "data" + }, + "x-permission": { + "operator": "OR", + "permissions": [ + "teams_read" + ] + } + }, + "post": { + "description": "Create a new team.\nUser IDs passed through the `users` relationship field are added to the team.", + "operationId": "CreateTeam", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request to create a team", + "properties": { + "data": { + "description": "Team create", + "properties": { + "attributes": { + "description": "Team creation attributes", + "properties": { + "avatar": { + "description": "Unicode representation of the avatar for the team, limited to a single grapheme", + "example": "🥑", + "nullable": true, + "type": "string" + }, + "banner": { + "description": "Banner selection for the team", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "description": { + "description": "Free-form markdown description/content for the team's homepage", + "type": "string" + }, + "handle": { + "description": "The team's identifier", + "example": "example-team", + "maxLength": 195, + "type": "string" + }, + "hidden_modules": { + "description": "Collection of hidden modules for the team", + "items": { + "description": "String identifier of the module", + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "The name of the team", + "example": "Example Team", + "maxLength": 200, + "type": "string" + }, + "visible_modules": { + "description": "Collection of visible modules for the team", + "items": { + "description": "String identifier of the module", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "handle", + "name" + ], + "type": "object" + }, + "relationships": { + "description": "Relationships formed with the team on creation", + "properties": { + "users": { + "description": "Relationship to users.", + "properties": { + "data": { + "description": "Relationships to user objects.", + "example": [], + "items": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Response with a team", + "properties": { + "data": { + "description": "A team", + "properties": { + "attributes": { + "description": "Team attributes", + "properties": { + "avatar": { + "description": "Unicode representation of the avatar for the team, limited to a single grapheme", + "example": "🥑", + "nullable": true, + "type": "string" + }, + "banner": { + "description": "Banner selection for the team", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "created_at": { + "description": "Creation date of the team", + "format": "date-time", + "type": "string" + }, + "description": { + "description": "Free-form markdown description/content for the team's homepage", + "nullable": true, + "type": "string" + }, + "handle": { + "description": "The team's identifier", + "example": "example-team", + "maxLength": 195, + "type": "string" + }, + "hidden_modules": { + "description": "Collection of hidden modules for the team", + "items": { + "description": "String identifier of the module", + "type": "string" + }, + "type": "array" + }, + "link_count": { + "description": "The number of links belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + }, + "modified_at": { + "description": "Modification date of the team", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "The name of the team", + "example": "Example Team", + "maxLength": 200, + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from the `description`", + "maxLength": 120, + "nullable": true, + "type": "string" + }, + "user_count": { + "description": "The number of users belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + }, + "visible_modules": { + "description": "Collection of visible modules for the team", + "items": { + "description": "String identifier of the module", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "handle", + "name" + ], + "type": "object" + }, + "id": { + "description": "The team's identifier", + "example": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "relationships": { + "description": "Resources related to a team", + "properties": { + "team_links": { + "description": "Relationship between a team and a team link", + "properties": { + "data": { + "description": "Related team links", + "items": { + "description": "Relationship between a link and a team", + "properties": { + "id": { + "description": "The team link's identifier", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team_links", + "description": "Team link type", + "enum": [ + "team_links" + ], + "example": "team_links", + "type": "string", + "x-enum-varnames": [ + "TEAM_LINKS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "links": { + "description": "Links attributes.", + "properties": { + "related": { + "description": "Related link.", + "example": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "user_team_permissions": { + "description": "Relationship between a user team permission and a team", + "properties": { + "data": { + "description": "Related user team permission data", + "properties": { + "id": { + "description": "The ID of the user team permission", + "example": "UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595", + "type": "string" + }, + "type": { + "default": "user_team_permissions", + "description": "User team permission type", + "enum": [ + "user_team_permissions" + ], + "example": "user_team_permissions", + "type": "string", + "x-enum-varnames": [ + "USER_TEAM_PERMISSIONS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "links": { + "description": "Links attributes.", + "properties": { + "related": { + "description": "Related link.", + "example": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "CREATED" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "409": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "API error response." + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "teams_read", + "teams_manage" + ] + } + ], + "summary": "Create a team", + "tags": [ + "Teams" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 2, + "x-permission": { + "operator": "AND", + "permissions": [ + "teams_read", + "teams_manage" + ] + } + } + }, + "/api/v2/team/connections": { + "delete": { + "description": "Delete multiple team connections.", + "operationId": "DeleteTeamConnections", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request for deleting team connections.", + "properties": { + "data": { + "description": "Array of team connection IDs to delete.", + "items": { + "description": "A collection of connection ids to delete.", + "properties": { + "id": { + "description": "The unique identifier of the team connection to delete.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "teams_read" + ] + } + ], + "summary": "Delete team connections", + "tags": [ + "Team Connections" + ], + "x-menu-order": 3, + "x-permission": { + "operator": "OR", + "permissions": [ + "teams_read" + ] + }, + "x-unstable": "**Note**: This endpoint is in Preview. To request access, fill out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/).\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "get": { + "description": "Returns all team connections.", + "operationId": "ListTeamConnections", + "parameters": [ + { + "description": "Size for a given page. The maximum allowed value is 100.", + "in": "query", + "name": "page[size]", + "required": false, + "schema": { + "default": 10, + "example": 10, + "format": "int64", + "type": "integer" + } + }, + { + "description": "Specific page number to return.", + "in": "query", + "name": "page[number]", + "required": false, + "schema": { + "default": 0, + "example": 0, + "format": "int64", + "type": "integer" + } + }, + { + "description": "Filter team connections by external source systems.", + "explode": false, + "in": "query", + "name": "filter[sources]", + "required": false, + "schema": { + "items": { + "example": "github", + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Filter team connections by Datadog team IDs.", + "explode": false, + "in": "query", + "name": "filter[team_ids]", + "required": false, + "schema": { + "items": { + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Filter team connections by connected team IDs from external systems.", + "explode": false, + "in": "query", + "name": "filter[connected_team_ids]", + "required": false, + "schema": { + "items": { + "example": "@MyGitHubAccount/my-team-name", + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Filter team connections by connection IDs.", + "explode": false, + "in": "query", + "name": "filter[connection_ids]", + "required": false, + "schema": { + "items": { + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response containing information about multiple team connections.", + "properties": { + "data": { + "description": "Array of team connections.", + "items": { + "description": "A relationship between a Datadog team and a team from another external system.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier of the team connection.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Connections response metadata.", + "properties": { + "page": { + "description": "Page-based pagination metadata.", + "properties": { + "first_number": { + "description": "The first page number.", + "format": "int64", + "type": "integer" + }, + "last_number": { + "description": "The last page number.", + "format": "int64", + "type": "integer" + }, + "next_number": { + "description": "The next page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "number": { + "description": "The current page number.", + "format": "int64", + "type": "integer" + }, + "prev_number": { + "description": "The previous page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "size": { + "description": "The page size.", + "format": "int64", + "type": "integer" + }, + "total": { + "description": "Total connections matching request.", + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Pagination type.", + "example": "number_size", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "teams_read" + ] + } + ], + "summary": "List team connections", + "tags": [ + "Team Connections" + ], + "x-menu-order": 1, + "x-pagination": { + "limitParam": "page[size]", + "pageParam": "page[number]", + "resultsPath": "data" + }, + "x-permission": { + "operator": "OR", + "permissions": [ + "teams_read" + ] + }, + "x-unstable": "**Note**: This endpoint is in Preview. To request access, fill out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/).\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "post": { + "description": "Create multiple team connections.", + "operationId": "CreateTeamConnections", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request for creating team connections.", + "properties": { + "data": { + "description": "Array of team connections to create.", + "items": { + "description": "Data for creating a team connection.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Response containing information about multiple team connections.", + "properties": { + "data": { + "description": "Array of team connections.", + "items": { + "description": "A relationship between a Datadog team and a team from another external system.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier of the team connection.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Connections response metadata.", + "properties": { + "page": { + "description": "Page-based pagination metadata.", + "properties": { + "first_number": { + "description": "The first page number.", + "format": "int64", + "type": "integer" + }, + "last_number": { + "description": "The last page number.", + "format": "int64", + "type": "integer" + }, + "next_number": { + "description": "The next page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "number": { + "description": "The current page number.", + "format": "int64", + "type": "integer" + }, + "prev_number": { + "description": "The previous page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "size": { + "description": "The page size.", + "format": "int64", + "type": "integer" + }, + "total": { + "description": "Total connections matching request.", + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Pagination type.", + "example": "number_size", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Created" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" }, "403": { "content": { @@ -722778,7 +724757,7 @@ } } }, - "description": "API error response." + "description": "Conflict" }, "429": { "content": { @@ -722816,24 +724795,22 @@ }, { "AuthZ": [ - "teams_read", - "teams_manage" + "teams_read" ] } ], - "summary": "Create a team", + "summary": "Create team connections", "tags": [ - "Teams" + "Team Connections" ], - "x-codegen-request-body-name": "body", "x-menu-order": 2, "x-permission": { - "operator": "AND", + "operator": "OR", "permissions": [ - "teams_read", - "teams_manage" + "teams_read" ] - } + }, + "x-unstable": "**Note**: This endpoint is in Preview. To request access, fill out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/).\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." } }, "/api/v2/team/sync": { @@ -748976,6 +750953,10 @@ "description": "Datadog Synthetics uses simulated user requests and browser rendering to help you ensure uptime,\nidentify regional issues, and track your application performance. Datadog Synthetics tests come in\ntwo different flavors, [API tests](https://docs.datadoghq.com/synthetics/api_tests/)\nand [browser tests](https://docs.datadoghq.com/synthetics/browser_tests). You can use Datadog’s API to\nmanage both test types programmatically.\n\nFor more information about Synthetics, see the [Synthetics overview](https://docs.datadoghq.com/synthetics/).", "name": "Synthetics" }, + { + "description": "View and manage relationships between Datadog teams and teams from external sources, such as GitHub.", + "name": "Team Connections" + }, { "description": "View and manage teams within Datadog. See the [Teams page](https://docs.datadoghq.com/account_management/teams/) for more information.", "name": "Teams" diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index 7f2bd3f91e451..b37909b3f0601 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -3068,6 +3068,22 @@ "request_description": "", "request_schema_description": "Request to create a team" }, + "DeleteTeamConnections": { + "description": "Delete multiple team connections.", + "summary": "Delete team connections", + "request_description": "", + "request_schema_description": "Request for deleting team connections." + }, + "ListTeamConnections": { + "description": "Returns all team connections.", + "summary": "List team connections" + }, + "CreateTeamConnections": { + "description": "Create multiple team connections.", + "summary": "Create team connections", + "request_description": "", + "request_schema_description": "Request for creating team connections." + }, "SyncTeams": { "description": "This endpoint attempts to link your existing Datadog teams with GitHub teams by matching their names.\nIt evaluates all current Datadog teams and compares them against teams in the GitHub organization\nconnected to your Datadog account, based on Datadog Team handle and GitHub Team slug\n(lowercased and kebab-cased).\n\nThis operation is read-only on the GitHub side, no teams will be modified or created.\n\n[A GitHub organization must be connected to your Datadog account](https://docs.datadoghq.com/integrations/github/),\nand the GitHub App integrated with Datadog must have the `Members Read` permission. Matching is performed by comparing the Datadog team handle to the GitHub team slug\nusing a normalized exact match; case is ignored and spaces are removed. No modifications are made\nto teams in GitHub. This will not create new Teams in Datadog.", "summary": "Link Teams with GitHub Teams", diff --git a/data/api/v2/translate_tags.json b/data/api/v2/translate_tags.json index da67e0f029d78..6724035ad11d8 100644 --- a/data/api/v2/translate_tags.json +++ b/data/api/v2/translate_tags.json @@ -311,6 +311,10 @@ "name": "Synthetics", "description": "Datadog Synthetics uses simulated user requests and browser rendering to help you ensure uptime,\nidentify regional issues, and track your application performance. Datadog Synthetics tests come in\ntwo different flavors, [API tests](https://docs.datadoghq.com/synthetics/api_tests/)\nand [browser tests](https://docs.datadoghq.com/synthetics/browser_tests). You can use Datadog’s API to\nmanage both test types programmatically.\n\nFor more information about Synthetics, see the [Synthetics overview](https://docs.datadoghq.com/synthetics/)." }, + "team-connections": { + "name": "Team Connections", + "description": "View and manage relationships between Datadog teams and teams from external sources, such as GitHub." + }, "teams": { "name": "Teams", "description": "View and manage teams within Datadog. See the [Teams page](https://docs.datadoghq.com/account_management/teams/) for more information." diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index 564eddc415e29..7031b899172e5 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -71405,6 +71405,78 @@ }, "type": "object" }, + "ConnectedTeamRef": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "ConnectedTeamRefData": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "ConnectedTeamRefDataType": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + }, "Connection": { "description": "The definition of `Connection` object.", "properties": { @@ -71546,6 +71618,108 @@ ], "type": "object" }, + "ConnectionsPagePagination": { + "description": "Page-based pagination metadata.", + "properties": { + "first_number": { + "description": "The first page number.", + "format": "int64", + "type": "integer" + }, + "last_number": { + "description": "The last page number.", + "format": "int64", + "type": "integer" + }, + "next_number": { + "description": "The next page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "number": { + "description": "The current page number.", + "format": "int64", + "type": "integer" + }, + "prev_number": { + "description": "The previous page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "size": { + "description": "The page size.", + "format": "int64", + "type": "integer" + }, + "total": { + "description": "Total connections matching request.", + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Pagination type.", + "example": "number_size", + "type": "string" + } + }, + "type": "object" + }, + "ConnectionsResponseMeta": { + "description": "Connections response metadata.", + "properties": { + "page": { + "description": "Page-based pagination metadata.", + "properties": { + "first_number": { + "description": "The first page number.", + "format": "int64", + "type": "integer" + }, + "last_number": { + "description": "The last page number.", + "format": "int64", + "type": "integer" + }, + "next_number": { + "description": "The next page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "number": { + "description": "The current page number.", + "format": "int64", + "type": "integer" + }, + "prev_number": { + "description": "The previous page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "size": { + "description": "The page size.", + "format": "int64", + "type": "integer" + }, + "total": { + "description": "Total connections matching request.", + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Pagination type.", + "example": "number_size", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "Container": { "description": "Container object.", "properties": { @@ -360771,6 +360945,698 @@ ], "type": "object" }, + "TeamConnection": { + "description": "A relationship between a Datadog team and a team from another external system.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier of the team connection.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "TeamConnectionAttributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "TeamConnectionCreateData": { + "description": "Data for creating a team connection.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "TeamConnectionCreateRequest": { + "description": "Request for creating team connections.", + "properties": { + "data": { + "description": "Array of team connections to create.", + "items": { + "description": "Data for creating a team connection.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "TeamConnectionDeleteRequest": { + "description": "Request for deleting team connections.", + "properties": { + "data": { + "description": "Array of team connection IDs to delete.", + "items": { + "description": "A collection of connection ids to delete.", + "properties": { + "id": { + "description": "The unique identifier of the team connection to delete.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "TeamConnectionDeleteRequestDataItem": { + "description": "A collection of connection ids to delete.", + "properties": { + "id": { + "description": "The unique identifier of the team connection to delete.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "TeamConnectionRelationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "TeamConnectionType": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + }, + "TeamConnectionsResponse": { + "description": "Response containing information about multiple team connections.", + "properties": { + "data": { + "description": "Array of team connections.", + "items": { + "description": "A relationship between a Datadog team and a team from another external system.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier of the team connection.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Connections response metadata.", + "properties": { + "page": { + "description": "Page-based pagination metadata.", + "properties": { + "first_number": { + "description": "The first page number.", + "format": "int64", + "type": "integer" + }, + "last_number": { + "description": "The last page number.", + "format": "int64", + "type": "integer" + }, + "next_number": { + "description": "The next page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "number": { + "description": "The current page number.", + "format": "int64", + "type": "integer" + }, + "prev_number": { + "description": "The previous page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "size": { + "description": "The page size.", + "format": "int64", + "type": "integer" + }, + "total": { + "description": "Total connections matching request.", + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Pagination type.", + "example": "number_size", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, "TeamCreate": { "description": "Team create", "properties": { @@ -363547,6 +364413,78 @@ }, "type": "object" }, + "TeamRef": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "TeamRefData": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "TeamRefDataType": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + }, "TeamReference": { "description": "Provides a reference to a team, including ID, type, and basic attributes/relationships.", "properties": { @@ -722326,403 +723264,1444 @@ } } }, - "description": "Too many requests" - } - }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "teams_read" - ] - } - ], - "summary": "Get all teams", - "tags": [ - "Teams" - ], - "x-menu-order": 1, - "x-pagination": { - "limitParam": "page[size]", - "pageParam": "page[number]", - "resultsPath": "data" - }, - "x-permission": { - "operator": "OR", - "permissions": [ - "teams_read" - ] - } - }, - "post": { - "description": "Create a new team.\nUser IDs passed through the `users` relationship field are added to the team.", - "operationId": "CreateTeam", - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "Request to create a team", - "properties": { - "data": { - "description": "Team create", - "properties": { - "attributes": { - "description": "Team creation attributes", - "properties": { - "avatar": { - "description": "Unicode representation of the avatar for the team, limited to a single grapheme", - "example": "🥑", - "nullable": true, - "type": "string" - }, - "banner": { - "description": "Banner selection for the team", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "description": { - "description": "Free-form markdown description/content for the team's homepage", - "type": "string" - }, - "handle": { - "description": "The team's identifier", - "example": "example-team", - "maxLength": 195, - "type": "string" - }, - "hidden_modules": { - "description": "Collection of hidden modules for the team", - "items": { - "description": "String identifier of the module", - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "The name of the team", - "example": "Example Team", - "maxLength": 200, - "type": "string" - }, - "visible_modules": { - "description": "Collection of visible modules for the team", - "items": { - "description": "String identifier of the module", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "handle", - "name" - ], - "type": "object" - }, - "relationships": { - "description": "Relationships formed with the team on creation", - "properties": { - "users": { - "description": "Relationship to users.", - "properties": { - "data": { - "description": "Relationships to user objects.", - "example": [], - "items": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "description": "Response with a team", - "properties": { - "data": { - "description": "A team", - "properties": { - "attributes": { - "description": "Team attributes", - "properties": { - "avatar": { - "description": "Unicode representation of the avatar for the team, limited to a single grapheme", - "example": "🥑", - "nullable": true, - "type": "string" - }, - "banner": { - "description": "Banner selection for the team", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "created_at": { - "description": "Creation date of the team", - "format": "date-time", - "type": "string" - }, - "description": { - "description": "Free-form markdown description/content for the team's homepage", - "nullable": true, - "type": "string" - }, - "handle": { - "description": "The team's identifier", - "example": "example-team", - "maxLength": 195, - "type": "string" - }, - "hidden_modules": { - "description": "Collection of hidden modules for the team", - "items": { - "description": "String identifier of the module", - "type": "string" - }, - "type": "array" - }, - "link_count": { - "description": "The number of links belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" - }, - "modified_at": { - "description": "Modification date of the team", - "format": "date-time", - "type": "string" - }, - "name": { - "description": "The name of the team", - "example": "Example Team", - "maxLength": 200, - "type": "string" - }, - "summary": { - "description": "A brief summary of the team, derived from the `description`", - "maxLength": 120, - "nullable": true, - "type": "string" - }, - "user_count": { - "description": "The number of users belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" - }, - "visible_modules": { - "description": "Collection of visible modules for the team", - "items": { - "description": "String identifier of the module", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "handle", - "name" - ], - "type": "object" - }, - "id": { - "description": "The team's identifier", - "example": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "relationships": { - "description": "Resources related to a team", - "properties": { - "team_links": { - "description": "Relationship between a team and a team link", - "properties": { - "data": { - "description": "Related team links", - "items": { - "description": "Relationship between a link and a team", - "properties": { - "id": { - "description": "The team link's identifier", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "type": { - "default": "team_links", - "description": "Team link type", - "enum": [ - "team_links" - ], - "example": "team_links", - "type": "string", - "x-enum-varnames": [ - "TEAM_LINKS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "type": "array" - }, - "links": { - "description": "Links attributes.", - "properties": { - "related": { - "description": "Related link.", - "example": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "user_team_permissions": { - "description": "Relationship between a user team permission and a team", - "properties": { - "data": { - "description": "Related user team permission data", - "properties": { - "id": { - "description": "The ID of the user team permission", - "example": "UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595", - "type": "string" - }, - "type": { - "default": "user_team_permissions", - "description": "User team permission type", - "enum": [ - "user_team_permissions" - ], - "example": "user_team_permissions", - "type": "string", - "x-enum-varnames": [ - "USER_TEAM_PERMISSIONS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "links": { - "description": "Links attributes.", - "properties": { - "related": { - "description": "Related link.", - "example": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - } - }, - "type": "object" - } - } - }, - "description": "CREATED" + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "teams_read" + ] + } + ], + "summary": "Get all teams", + "tags": [ + "Teams" + ], + "x-menu-order": 1, + "x-pagination": { + "limitParam": "page[size]", + "pageParam": "page[number]", + "resultsPath": "data" + }, + "x-permission": { + "operator": "OR", + "permissions": [ + "teams_read" + ] + } + }, + "post": { + "description": "Create a new team.\nUser IDs passed through the `users` relationship field are added to the team.", + "operationId": "CreateTeam", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request to create a team", + "properties": { + "data": { + "description": "Team create", + "properties": { + "attributes": { + "description": "Team creation attributes", + "properties": { + "avatar": { + "description": "Unicode representation of the avatar for the team, limited to a single grapheme", + "example": "🥑", + "nullable": true, + "type": "string" + }, + "banner": { + "description": "Banner selection for the team", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "description": { + "description": "Free-form markdown description/content for the team's homepage", + "type": "string" + }, + "handle": { + "description": "The team's identifier", + "example": "example-team", + "maxLength": 195, + "type": "string" + }, + "hidden_modules": { + "description": "Collection of hidden modules for the team", + "items": { + "description": "String identifier of the module", + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "The name of the team", + "example": "Example Team", + "maxLength": 200, + "type": "string" + }, + "visible_modules": { + "description": "Collection of visible modules for the team", + "items": { + "description": "String identifier of the module", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "handle", + "name" + ], + "type": "object" + }, + "relationships": { + "description": "Relationships formed with the team on creation", + "properties": { + "users": { + "description": "Relationship to users.", + "properties": { + "data": { + "description": "Relationships to user objects.", + "example": [], + "items": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Response with a team", + "properties": { + "data": { + "description": "A team", + "properties": { + "attributes": { + "description": "Team attributes", + "properties": { + "avatar": { + "description": "Unicode representation of the avatar for the team, limited to a single grapheme", + "example": "🥑", + "nullable": true, + "type": "string" + }, + "banner": { + "description": "Banner selection for the team", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "created_at": { + "description": "Creation date of the team", + "format": "date-time", + "type": "string" + }, + "description": { + "description": "Free-form markdown description/content for the team's homepage", + "nullable": true, + "type": "string" + }, + "handle": { + "description": "The team's identifier", + "example": "example-team", + "maxLength": 195, + "type": "string" + }, + "hidden_modules": { + "description": "Collection of hidden modules for the team", + "items": { + "description": "String identifier of the module", + "type": "string" + }, + "type": "array" + }, + "link_count": { + "description": "The number of links belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + }, + "modified_at": { + "description": "Modification date of the team", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "The name of the team", + "example": "Example Team", + "maxLength": 200, + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from the `description`", + "maxLength": 120, + "nullable": true, + "type": "string" + }, + "user_count": { + "description": "The number of users belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + }, + "visible_modules": { + "description": "Collection of visible modules for the team", + "items": { + "description": "String identifier of the module", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "handle", + "name" + ], + "type": "object" + }, + "id": { + "description": "The team's identifier", + "example": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "relationships": { + "description": "Resources related to a team", + "properties": { + "team_links": { + "description": "Relationship between a team and a team link", + "properties": { + "data": { + "description": "Related team links", + "items": { + "description": "Relationship between a link and a team", + "properties": { + "id": { + "description": "The team link's identifier", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team_links", + "description": "Team link type", + "enum": [ + "team_links" + ], + "example": "team_links", + "type": "string", + "x-enum-varnames": [ + "TEAM_LINKS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "links": { + "description": "Links attributes.", + "properties": { + "related": { + "description": "Related link.", + "example": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "user_team_permissions": { + "description": "Relationship between a user team permission and a team", + "properties": { + "data": { + "description": "Related user team permission data", + "properties": { + "id": { + "description": "The ID of the user team permission", + "example": "UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595", + "type": "string" + }, + "type": { + "default": "user_team_permissions", + "description": "User team permission type", + "enum": [ + "user_team_permissions" + ], + "example": "user_team_permissions", + "type": "string", + "x-enum-varnames": [ + "USER_TEAM_PERMISSIONS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "links": { + "description": "Links attributes.", + "properties": { + "related": { + "description": "Related link.", + "example": "/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "CREATED" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "409": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "API error response." + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "teams_read", + "teams_manage" + ] + } + ], + "summary": "Create a team", + "tags": [ + "Teams" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 2, + "x-permission": { + "operator": "AND", + "permissions": [ + "teams_read", + "teams_manage" + ] + } + } + }, + "/api/v2/team/connections": { + "delete": { + "description": "Delete multiple team connections.", + "operationId": "DeleteTeamConnections", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request for deleting team connections.", + "properties": { + "data": { + "description": "Array of team connection IDs to delete.", + "items": { + "description": "A collection of connection ids to delete.", + "properties": { + "id": { + "description": "The unique identifier of the team connection to delete.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "teams_read" + ] + } + ], + "summary": "Delete team connections", + "tags": [ + "Team Connections" + ], + "x-menu-order": 3, + "x-permission": { + "operator": "OR", + "permissions": [ + "teams_read" + ] + }, + "x-unstable": "**Note**: This endpoint is in Preview. To request access, fill out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/).\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "get": { + "description": "Returns all team connections.", + "operationId": "ListTeamConnections", + "parameters": [ + { + "description": "Size for a given page. The maximum allowed value is 100.", + "in": "query", + "name": "page[size]", + "required": false, + "schema": { + "default": 10, + "example": 10, + "format": "int64", + "type": "integer" + } + }, + { + "description": "Specific page number to return.", + "in": "query", + "name": "page[number]", + "required": false, + "schema": { + "default": 0, + "example": 0, + "format": "int64", + "type": "integer" + } + }, + { + "description": "Filter team connections by external source systems.", + "explode": false, + "in": "query", + "name": "filter[sources]", + "required": false, + "schema": { + "items": { + "example": "github", + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Filter team connections by Datadog team IDs.", + "explode": false, + "in": "query", + "name": "filter[team_ids]", + "required": false, + "schema": { + "items": { + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Filter team connections by connected team IDs from external systems.", + "explode": false, + "in": "query", + "name": "filter[connected_team_ids]", + "required": false, + "schema": { + "items": { + "example": "@MyGitHubAccount/my-team-name", + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Filter team connections by connection IDs.", + "explode": false, + "in": "query", + "name": "filter[connection_ids]", + "required": false, + "schema": { + "items": { + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response containing information about multiple team connections.", + "properties": { + "data": { + "description": "Array of team connections.", + "items": { + "description": "A relationship between a Datadog team and a team from another external system.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier of the team connection.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Connections response metadata.", + "properties": { + "page": { + "description": "Page-based pagination metadata.", + "properties": { + "first_number": { + "description": "The first page number.", + "format": "int64", + "type": "integer" + }, + "last_number": { + "description": "The last page number.", + "format": "int64", + "type": "integer" + }, + "next_number": { + "description": "The next page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "number": { + "description": "The current page number.", + "format": "int64", + "type": "integer" + }, + "prev_number": { + "description": "The previous page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "size": { + "description": "The page size.", + "format": "int64", + "type": "integer" + }, + "total": { + "description": "Total connections matching request.", + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Pagination type.", + "example": "number_size", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "teams_read" + ] + } + ], + "summary": "List team connections", + "tags": [ + "Team Connections" + ], + "x-menu-order": 1, + "x-pagination": { + "limitParam": "page[size]", + "pageParam": "page[number]", + "resultsPath": "data" + }, + "x-permission": { + "operator": "OR", + "permissions": [ + "teams_read" + ] + }, + "x-unstable": "**Note**: This endpoint is in Preview. To request access, fill out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/).\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "post": { + "description": "Create multiple team connections.", + "operationId": "CreateTeamConnections", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request for creating team connections.", + "properties": { + "data": { + "description": "Array of team connections to create.", + "items": { + "description": "Data for creating a team connection.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Response containing information about multiple team connections.", + "properties": { + "data": { + "description": "Array of team connections.", + "items": { + "description": "A relationship between a Datadog team and a team from another external system.", + "properties": { + "attributes": { + "description": "Attributes of the team connection.", + "properties": { + "managed_by": { + "description": "The entity that manages this team connection.", + "example": "github_sync", + "type": "string" + }, + "source": { + "description": "The name of the external source.", + "example": "github", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier of the team connection.", + "example": "12345678-1234-5678-9abc-123456789012", + "type": "string" + }, + "relationships": { + "description": "Relationships of the team connection.", + "properties": { + "connected_team": { + "description": "Reference to a team from an external system.", + "properties": { + "data": { + "description": "Reference to connected external team.", + "properties": { + "id": { + "description": "The connected team ID as it is referenced throughout the Datadog ecosystem.", + "example": "@GitHubOrg/team-handle", + "type": "string" + }, + "type": { + "default": "github_team", + "description": "External team resource type.", + "enum": [ + "github_team" + ], + "example": "github_team", + "type": "string", + "x-enum-varnames": [ + "GITHUB_TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + }, + "team": { + "description": "Reference to a Datadog team.", + "properties": { + "data": { + "description": "Reference to a Datadog team.", + "properties": { + "id": { + "description": "The Datadog team ID.", + "example": "87654321-4321-8765-dcba-210987654321", + "type": "string" + }, + "type": { + "default": "team", + "description": "Datadog team resource type.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "team_connection", + "description": "Team connection resource type.", + "enum": [ + "team_connection" + ], + "example": "team_connection", + "type": "string", + "x-enum-varnames": [ + "TEAM_CONNECTION" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Connections response metadata.", + "properties": { + "page": { + "description": "Page-based pagination metadata.", + "properties": { + "first_number": { + "description": "The first page number.", + "format": "int64", + "type": "integer" + }, + "last_number": { + "description": "The last page number.", + "format": "int64", + "type": "integer" + }, + "next_number": { + "description": "The next page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "number": { + "description": "The current page number.", + "format": "int64", + "type": "integer" + }, + "prev_number": { + "description": "The previous page number.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "size": { + "description": "The page size.", + "format": "int64", + "type": "integer" + }, + "total": { + "description": "Total connections matching request.", + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Pagination type.", + "example": "number_size", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Created" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" }, "403": { "content": { @@ -722778,7 +724757,7 @@ } } }, - "description": "API error response." + "description": "Conflict" }, "429": { "content": { @@ -722816,24 +724795,22 @@ }, { "AuthZ": [ - "teams_read", - "teams_manage" + "teams_read" ] } ], - "summary": "Create a team", + "summary": "Create team connections", "tags": [ - "Teams" + "Team Connections" ], - "x-codegen-request-body-name": "body", "x-menu-order": 2, "x-permission": { - "operator": "AND", + "operator": "OR", "permissions": [ - "teams_read", - "teams_manage" + "teams_read" ] - } + }, + "x-unstable": "**Note**: This endpoint is in Preview. To request access, fill out this [form](https://www.datadoghq.com/product-preview/github-integration-for-teams/).\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." } }, "/api/v2/team/sync": { @@ -748976,6 +750953,10 @@ "description": "Datadog Synthetics uses simulated user requests and browser rendering to help you ensure uptime,\nidentify regional issues, and track your application performance. Datadog Synthetics tests come in\ntwo different flavors, [API tests](https://docs.datadoghq.com/synthetics/api_tests/)\nand [browser tests](https://docs.datadoghq.com/synthetics/browser_tests). You can use Datadog’s API to\nmanage both test types programmatically.\n\nFor more information about Synthetics, see the [Synthetics overview](https://docs.datadoghq.com/synthetics/).", "name": "Synthetics" }, + { + "description": "View and manage relationships between Datadog teams and teams from external sources, such as GitHub.", + "name": "Team Connections" + }, { "description": "View and manage teams within Datadog. See the [Teams page](https://docs.datadoghq.com/account_management/teams/) for more information.", "name": "Teams"