diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 7b0ed737c28..e850f44d14c 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -11439,6 +11439,66 @@ menu: - GetTeamPermissionSettings unstable: [] order: 17 + - name: Update team notification rule + url: '#update-team-notification-rule' + identifier: teams-update-team-notification-rule + parent: teams + generated: true + params: + versions: + - v2 + operationids: + - UpdateTeamNotificationRule + unstable: [] + order: 30 + - name: Get team notification rule + url: '#get-team-notification-rule' + identifier: teams-get-team-notification-rule + parent: teams + generated: true + params: + versions: + - v2 + operationids: + - GetTeamNotificationRule + unstable: [] + order: 29 + - name: Delete team notification rule + url: '#delete-team-notification-rule' + identifier: teams-delete-team-notification-rule + parent: teams + generated: true + params: + versions: + - v2 + operationids: + - DeleteTeamNotificationRule + unstable: [] + order: 31 + - name: Create team notification rule + url: '#create-team-notification-rule' + identifier: teams-create-team-notification-rule + parent: teams + generated: true + params: + versions: + - v2 + operationids: + - CreateTeamNotificationRule + unstable: [] + order: 28 + - name: Get team notification rules + url: '#get-team-notification-rules' + identifier: teams-get-team-notification-rules + parent: teams + generated: true + params: + versions: + - v2 + operationids: + - GetTeamNotificationRules + unstable: [] + order: 27 - name: Update a user's membership attributes on a team url: '#update-a-users-membership-attributes-on-a-team' identifier: teams-update-a-users-membership-attributes-on-a-team @@ -11657,7 +11717,7 @@ menu: operationids: - CreateTeamConnections unstable: [] - order: 2 + order: 25 - name: List team connections url: '#list-team-connections' identifier: teams-list-team-connections @@ -11669,7 +11729,7 @@ menu: operationids: - ListTeamConnections unstable: [] - order: 1 + order: 24 - name: Delete team connections url: '#delete-team-connections' identifier: teams-delete-team-connections @@ -11681,7 +11741,7 @@ menu: operationids: - DeleteTeamConnections unstable: [] - order: 3 + order: 26 - name: Get a team hierarchy link url: '#get-a-team-hierarchy-link' identifier: teams-get-a-team-hierarchy-link diff --git a/content/en/api/v2/teams/examples.json b/content/en/api/v2/teams/examples.json index 336c6412884..ed0491fa145 100644 --- a/content/en/api/v2/teams/examples.json +++ b/content/en/api/v2/teams/examples.json @@ -2217,6 +2217,339 @@ "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A user's relationship with a team

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

attributes

\n
\n

object

\n

Team membership attributes

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

provisioned_by

\n
\n

string

\n

The mechanism responsible for provisioning the team relationship.\nPossible values: null for added by a user, "service_account" if added by a service account, and "saml_mapping" if provisioned via SAML mapping.

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

provisioned_by_id

\n
\n

string

\n

UUID of the User or Service Account who provisioned this team membership, or null if provisioned via SAML mapping.

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

role

\n
\n

enum

\n

The user's role within the team \nAllowed enum values: admin

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

type [required]

\n
\n

enum

\n

Team membership type \nAllowed enum values: team_memberships

default: team_memberships

\n
\n \n
\n
\n
\n
" } }, + "GetTeamNotificationRules": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "email": { + "enabled": false + }, + "ms_teams": { + "connector_name": "string" + }, + "pagerduty": { + "service_name": "string" + }, + "slack": { + "channel": "string", + "workspace": "string" + } + }, + "id": "b8626d7e-cedd-11eb-abf5-da7ad0900001", + "type": "team_notification_rules" + } + ], + "meta": { + "page": { + "first_offset": "integer", + "last_offset": "integer", + "limit": "integer", + "next_offset": "integer", + "offset": "integer", + "prev_offset": "integer", + "total": "integer", + "type": "string" + } + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Team notification rules response data

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

attributes [required]

\n
\n

object

\n

Team notification rule attributes

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

email

\n
\n

object

\n

Email notification settings for the team

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

enabled

\n
\n

boolean

\n

Flag indicating email notification

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

ms_teams

\n
\n

object

\n

MS Teams notification settings for the team

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

connector_name

\n
\n

string

\n

Handle for MS Teams

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

pagerduty

\n
\n

object

\n

PagerDuty notification settings for the team

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

service_name

\n
\n

string

\n

Service name for PagerDuty

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

slack

\n
\n

object

\n

Slack notification settings for the team

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

channel

\n
\n

string

\n

Channel for Slack notification

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

workspace

\n
\n

string

\n

Workspace for Slack notification

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

id

\n
\n

string

\n

The identifier of the team notification rule

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

type [required]

\n
\n

enum

\n

Team notification rule type \nAllowed enum values: team_notification_rules

default: team_notification_rules

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

meta

\n
\n

object

\n

Metadata that is included in the response when querying the team notification rules

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

page

\n
\n

object

\n

Metadata related to paging information that is included in the response when querying the team notification rules

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

first_offset

\n
\n

int64

\n

The first offset.

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

last_offset

\n
\n

int64

\n

The last offset.

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

limit

\n
\n

int64

\n

Pagination limit.

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

next_offset

\n
\n

int64

\n

The next offset.

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

offset

\n
\n

int64

\n

The offset.

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

prev_offset

\n
\n

int64

\n

The previous offset.

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

total

\n
\n

int64

\n

Total results.

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

type

\n
\n

string

\n

Offset type.

\n
\n \n
\n
\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": {}, + "json": {}, + "html": "" + } + }, + "CreateTeamNotificationRule": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "email": { + "enabled": false + }, + "ms_teams": { + "connector_name": "string" + }, + "pagerduty": { + "service_name": "string" + }, + "slack": { + "channel": "string", + "workspace": "string" + } + }, + "id": "b8626d7e-cedd-11eb-abf5-da7ad0900001", + "type": "team_notification_rules" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Team notification rule

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

attributes [required]

\n
\n

object

\n

Team notification rule attributes

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

email

\n
\n

object

\n

Email notification settings for the team

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

enabled

\n
\n

boolean

\n

Flag indicating email notification

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

ms_teams

\n
\n

object

\n

MS Teams notification settings for the team

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

connector_name

\n
\n

string

\n

Handle for MS Teams

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

pagerduty

\n
\n

object

\n

PagerDuty notification settings for the team

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

service_name

\n
\n

string

\n

Service name for PagerDuty

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

slack

\n
\n

object

\n

Slack notification settings for the team

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

channel

\n
\n

string

\n

Channel for Slack notification

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

workspace

\n
\n

string

\n

Workspace for Slack notification

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

id

\n
\n

string

\n

The identifier of the team notification rule

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

type [required]

\n
\n

enum

\n

Team notification rule type \nAllowed enum values: team_notification_rules

default: team_notification_rules

\n
\n \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
" + }, + "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": { + "attributes": {}, + "type": "team_notification_rules" + } + }, + "json": { + "data": { + "attributes": { + "email": { + "enabled": false + }, + "ms_teams": { + "connector_name": "string" + }, + "pagerduty": { + "service_name": "string" + }, + "slack": { + "channel": "string", + "workspace": "string" + } + }, + "id": "b8626d7e-cedd-11eb-abf5-da7ad0900001", + "type": "team_notification_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Team notification rule

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

attributes [required]

\n
\n

object

\n

Team notification rule attributes

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

email

\n
\n

object

\n

Email notification settings for the team

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

enabled

\n
\n

boolean

\n

Flag indicating email notification

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

ms_teams

\n
\n

object

\n

MS Teams notification settings for the team

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

connector_name

\n
\n

string

\n

Handle for MS Teams

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

pagerduty

\n
\n

object

\n

PagerDuty notification settings for the team

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

service_name

\n
\n

string

\n

Service name for PagerDuty

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

slack

\n
\n

object

\n

Slack notification settings for the team

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

channel

\n
\n

string

\n

Channel for Slack notification

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

workspace

\n
\n

string

\n

Workspace for Slack notification

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

id

\n
\n

string

\n

The identifier of the team notification rule

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

type [required]

\n
\n

enum

\n

Team notification rule type \nAllowed enum values: team_notification_rules

default: team_notification_rules

\n
\n \n
\n
\n
\n
" + } + }, + "DeleteTeamNotificationRule": { + "responses": { + "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": {}, + "json": {}, + "html": "" + } + }, + "GetTeamNotificationRule": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "email": { + "enabled": false + }, + "ms_teams": { + "connector_name": "string" + }, + "pagerduty": { + "service_name": "string" + }, + "slack": { + "channel": "string", + "workspace": "string" + } + }, + "id": "b8626d7e-cedd-11eb-abf5-da7ad0900001", + "type": "team_notification_rules" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Team notification rule

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

attributes [required]

\n
\n

object

\n

Team notification rule attributes

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

email

\n
\n

object

\n

Email notification settings for the team

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

enabled

\n
\n

boolean

\n

Flag indicating email notification

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

ms_teams

\n
\n

object

\n

MS Teams notification settings for the team

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

connector_name

\n
\n

string

\n

Handle for MS Teams

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

pagerduty

\n
\n

object

\n

PagerDuty notification settings for the team

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

service_name

\n
\n

string

\n

Service name for PagerDuty

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

slack

\n
\n

object

\n

Slack notification settings for the team

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

channel

\n
\n

string

\n

Channel for Slack notification

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

workspace

\n
\n

string

\n

Workspace for Slack notification

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

id

\n
\n

string

\n

The identifier of the team notification rule

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

type [required]

\n
\n

enum

\n

Team notification rule type \nAllowed enum values: team_notification_rules

default: team_notification_rules

\n
\n \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": {}, + "json": {}, + "html": "" + } + }, + "UpdateTeamNotificationRule": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "email": { + "enabled": false + }, + "ms_teams": { + "connector_name": "string" + }, + "pagerduty": { + "service_name": "string" + }, + "slack": { + "channel": "string", + "workspace": "string" + } + }, + "id": "b8626d7e-cedd-11eb-abf5-da7ad0900001", + "type": "team_notification_rules" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Team notification rule

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

attributes [required]

\n
\n

object

\n

Team notification rule attributes

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

email

\n
\n

object

\n

Email notification settings for the team

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

enabled

\n
\n

boolean

\n

Flag indicating email notification

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

ms_teams

\n
\n

object

\n

MS Teams notification settings for the team

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

connector_name

\n
\n

string

\n

Handle for MS Teams

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

pagerduty

\n
\n

object

\n

PagerDuty notification settings for the team

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

service_name

\n
\n

string

\n

Service name for PagerDuty

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

slack

\n
\n

object

\n

Slack notification settings for the team

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

channel

\n
\n

string

\n

Channel for Slack notification

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

workspace

\n
\n

string

\n

Workspace for Slack notification

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

id

\n
\n

string

\n

The identifier of the team notification rule

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

type [required]

\n
\n

enum

\n

Team notification rule type \nAllowed enum values: team_notification_rules

default: team_notification_rules

\n
\n \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": { + "attributes": {}, + "type": "team_notification_rules" + } + }, + "json": { + "data": { + "attributes": { + "email": { + "enabled": false + }, + "ms_teams": { + "connector_name": "string" + }, + "pagerduty": { + "service_name": "string" + }, + "slack": { + "channel": "string", + "workspace": "string" + } + }, + "id": "b8626d7e-cedd-11eb-abf5-da7ad0900001", + "type": "team_notification_rules" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Team notification rule

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

attributes [required]

\n
\n

object

\n

Team notification rule attributes

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

email

\n
\n

object

\n

Email notification settings for the team

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

enabled

\n
\n

boolean

\n

Flag indicating email notification

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

ms_teams

\n
\n

object

\n

MS Teams notification settings for the team

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

connector_name

\n
\n

string

\n

Handle for MS Teams

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

pagerduty

\n
\n

object

\n

PagerDuty notification settings for the team

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

service_name

\n
\n

string

\n

Service name for PagerDuty

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

slack

\n
\n

object

\n

Slack notification settings for the team

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

channel

\n
\n

string

\n

Channel for Slack notification

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

workspace

\n
\n

string

\n

Workspace for Slack notification

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

id

\n
\n

string

\n

The identifier of the team notification rule

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

type [required]

\n
\n

enum

\n

Team notification rule type \nAllowed enum values: team_notification_rules

default: team_notification_rules

\n
\n \n
\n
\n
\n
" + } + }, "GetTeamPermissionSettings": { "responses": { "200": { diff --git a/content/en/api/v2/teams/request.CreateTeamNotificationRule.json b/content/en/api/v2/teams/request.CreateTeamNotificationRule.json new file mode 100644 index 00000000000..088a1010ca2 --- /dev/null +++ b/content/en/api/v2/teams/request.CreateTeamNotificationRule.json @@ -0,0 +1,14 @@ +{ + "data": { + "type": "team_notification_rules", + "attributes": { + "email": { + "enabled": true + }, + "slack": { + "workspace": "Datadog", + "channel": "aaa-omg-ops" + } + } + } +} \ No newline at end of file diff --git a/content/en/api/v2/teams/request.UpdateTeamNotificationRule.json b/content/en/api/v2/teams/request.UpdateTeamNotificationRule.json new file mode 100644 index 00000000000..28bdf23ce24 --- /dev/null +++ b/content/en/api/v2/teams/request.UpdateTeamNotificationRule.json @@ -0,0 +1,15 @@ +{ + "data": { + "type": "team_notification_rules", + "id": "b8626d7e-cedd-11eb-abf5-da7ad0900001", + "attributes": { + "pagerduty": { + "service_name": "Datadog-prod" + }, + "slack": { + "workspace": "Datadog", + "channel": "aaa-governance-ops" + } + } + } +} \ No newline at end of file diff --git a/data/api/v2/CodeExamples.json b/data/api/v2/CodeExamples.json index af9733f64fb..f4ce3cde6f8 100644 --- a/data/api/v2/CodeExamples.json +++ b/data/api/v2/CodeExamples.json @@ -1922,6 +1922,13 @@ "description": "Create a team with V2 fields returns \"CREATED\" response" } ], + "CreateTeamNotificationRule": [ + { + "group": "teams", + "suffix": "", + "description": "Create team notification rule returns \"OK\" response" + } + ], "SyncTeams": [ { "group": "teams", @@ -1950,6 +1957,13 @@ "description": "Update permission setting for team returns \"OK\" response" } ], + "UpdateTeamNotificationRule": [ + { + "group": "teams", + "suffix": "", + "description": "Update team notification rule returns \"OK\" response" + } + ], "CreateUser": [ { "group": "users", diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index e3b6cff203f..464fe2ee66a 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -54642,6 +54642,143 @@ components: $ref: '#/components/schemas/TeamLink' type: array type: object + TeamNotificationRule: + description: Team notification rule + properties: + attributes: + $ref: '#/components/schemas/TeamNotificationRuleAttributes' + id: + description: The identifier of the team notification rule + example: b8626d7e-cedd-11eb-abf5-da7ad0900001 + type: string + type: + $ref: '#/components/schemas/TeamNotificationRuleType' + required: + - attributes + - type + type: object + TeamNotificationRuleAttributes: + description: Team notification rule attributes + properties: + email: + $ref: '#/components/schemas/TeamNotificationRuleAttributesEmail' + ms_teams: + $ref: '#/components/schemas/TeamNotificationRuleAttributesMsTeams' + pagerduty: + $ref: '#/components/schemas/TeamNotificationRuleAttributesPagerduty' + slack: + $ref: '#/components/schemas/TeamNotificationRuleAttributesSlack' + type: object + TeamNotificationRuleAttributesEmail: + description: Email notification settings for the team + properties: + enabled: + description: Flag indicating email notification + type: boolean + type: object + TeamNotificationRuleAttributesMsTeams: + description: MS Teams notification settings for the team + properties: + connector_name: + description: Handle for MS Teams + type: string + type: object + TeamNotificationRuleAttributesPagerduty: + description: PagerDuty notification settings for the team + properties: + service_name: + description: Service name for PagerDuty + type: string + type: object + TeamNotificationRuleAttributesSlack: + description: Slack notification settings for the team + properties: + channel: + description: Channel for Slack notification + type: string + workspace: + description: Workspace for Slack notification + type: string + type: object + TeamNotificationRuleRequest: + description: Request to create or update a team notification rule + properties: + data: + $ref: '#/components/schemas/TeamNotificationRule' + required: + - data + type: object + TeamNotificationRuleResponse: + description: Team notification rule response + properties: + data: + $ref: '#/components/schemas/TeamNotificationRule' + type: object + TeamNotificationRuleType: + default: team_notification_rules + description: Team notification rule type + enum: + - team_notification_rules + example: team_notification_rules + type: string + x-enum-varnames: + - TEAM_NOTIFICATION_RULES + TeamNotificationRulesResponse: + description: Team notification rules response + properties: + data: + description: Team notification rules response data + items: + $ref: '#/components/schemas/TeamNotificationRule' + type: array + meta: + $ref: '#/components/schemas/TeamNotificationRulesResponseMeta' + type: object + TeamNotificationRulesResponseMeta: + description: Metadata that is included in the response when querying the team + notification rules + properties: + page: + $ref: '#/components/schemas/TeamNotificationRulesResponseMetaPage' + type: object + TeamNotificationRulesResponseMetaPage: + description: Metadata related to paging information that is included in the + response when querying the team notification rules + properties: + first_offset: + description: The first offset. + format: int64 + type: integer + last_offset: + description: The last offset. + format: int64 + type: integer + limit: + description: Pagination limit. + format: int64 + type: integer + next_offset: + description: The next offset. + format: int64 + nullable: true + type: integer + offset: + description: The offset. + format: int64 + type: integer + prev_offset: + description: The previous offset. + format: int64 + nullable: true + type: integer + total: + description: Total results. + format: int64 + type: integer + type: + description: Offset type. + type: string + type: object TeamOnCallResponders: description: Root object representing a team's on-call responder configuration. example: @@ -87708,7 +87845,7 @@ paths: summary: Delete team connections tags: - Teams - x-menu-order: 3 + x-menu-order: 26 x-permission: operator: OR permissions: @@ -87784,7 +87921,7 @@ paths: summary: List team connections tags: - Teams - x-menu-order: 1 + x-menu-order: 24 x-pagination: limitParam: page[size] pageParam: page[number] @@ -87825,7 +87962,7 @@ paths: summary: Create team connections tags: - Teams - x-menu-order: 2 + x-menu-order: 25 x-permission: operator: OR permissions: @@ -88712,6 +88849,235 @@ paths: operator: OR permissions: - teams_read + /api/v2/team/{team_id}/notification-rules: + get: + operationId: GetTeamNotificationRules + parameters: + - description: None + in: path + name: team_id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TeamNotificationRulesResponse' + description: OK + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: API error response. + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read + summary: Get team notification rules + tags: + - Teams + x-menu-order: 27 + x-permission: + operator: OR + permissions: + - teams_read + post: + operationId: CreateTeamNotificationRule + parameters: + - description: None + in: path + name: team_id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TeamNotificationRuleRequest' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/TeamNotificationRuleResponse' + description: OK + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: API error response. + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: API error response. + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read + summary: Create team notification rule + tags: + - Teams + x-menu-order: 28 + x-permission: + operator: OR + permissions: + - teams_read + /api/v2/team/{team_id}/notification-rules/{rule_id}: + delete: + operationId: DeleteTeamNotificationRule + parameters: + - description: None + in: path + name: team_id + required: true + schema: + type: string + - description: None + in: path + name: rule_id + required: true + schema: + type: string + responses: + '204': + description: No Content + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: API error response. + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read + summary: Delete team notification rule + tags: + - Teams + x-menu-order: 31 + x-permission: + operator: OR + permissions: + - teams_read + get: + operationId: GetTeamNotificationRule + parameters: + - description: None + in: path + name: team_id + required: true + schema: + type: string + - description: None + in: path + name: rule_id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TeamNotificationRuleResponse' + description: OK + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: API error response. + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read + summary: Get team notification rule + tags: + - Teams + x-menu-order: 29 + x-permission: + operator: OR + permissions: + - teams_read + put: + operationId: UpdateTeamNotificationRule + parameters: + - description: None + in: path + name: team_id + required: true + schema: + type: string + - description: None + in: path + name: rule_id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TeamNotificationRuleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TeamNotificationRuleResponse' + description: OK + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: API error response. + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - teams_read + summary: Update team notification rule + tags: + - Teams + x-menu-order: 30 + x-permission: + operator: OR + permissions: + - teams_read /api/v2/team/{team_id}/permission-settings: get: description: Get all permission settings for a given team. diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index d6f9d7fc888..222fc7b9c11 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -3341,6 +3341,25 @@ "request_description": "", "request_schema_description": "Team membership request" }, + "GetTeamNotificationRules": { + "summary": "Get team notification rules" + }, + "CreateTeamNotificationRule": { + "summary": "Create team notification rule", + "request_description": "", + "request_schema_description": "Request to create or update a team notification rule" + }, + "DeleteTeamNotificationRule": { + "summary": "Delete team notification rule" + }, + "GetTeamNotificationRule": { + "summary": "Get team notification rule" + }, + "UpdateTeamNotificationRule": { + "summary": "Update team notification rule", + "request_description": "", + "request_schema_description": "Request to create or update a team notification rule" + }, "GetTeamPermissionSettings": { "description": "Get all permission settings for a given team.", "summary": "Get permission settings for a team"