Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions config/_default/menus/api.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9527,6 +9527,23 @@ menu:
- ListContainers
unstable: []
order: 1
- name: Customer Org
url: /api/latest/customer-org/
identifier: customer-org
generated: true
- name: Disable the authenticated customer organization
url: '#disable-the-authenticated-customer-organization'
identifier: customer-org-disable-the-authenticated-customer-organization
parent: customer-org
generated: true
params:
versions:
- v2
operationids:
- DisableCustomerOrg
unstable:
- v2
order: 1
- name: DORA Metrics
url: /api/latest/dora-metrics/
identifier: dora-metrics
Expand Down
3 changes: 3 additions & 0 deletions content/en/api/latest/customer-org/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Customer Org
---
4 changes: 4 additions & 0 deletions content/en/api/v2/customer-org/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Customer Org
headless: true
---
98 changes: 98 additions & 0 deletions content/en/api/v2/customer-org/examples.json

Large diffs are not rendered by default.

155 changes: 155 additions & 0 deletions data/api/v2/full_spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23102,6 +23102,91 @@ components:
required:
- data
type: object
CustomerOrgDisableRequest:
description: Request payload for disabling the authenticated customer organization.
properties:
data:
$ref: "#/components/schemas/CustomerOrgDisableRequestData"
required:
- data
type: object
CustomerOrgDisableRequestAttributes:
description: |-
Optional attributes for a customer org disable request. When supplied, `org_id` and
`org_uuid` must match the authenticated organization or the request is rejected.
properties:
org_id:
description: |-
Numeric Datadog organization identifier. If supplied, must match the
authenticated organization.
example: 123
format: int64
type: integer
org_uuid:
description: |-
Datadog organization UUID. If supplied, must match the authenticated
organization.
example: "abcdef01-2345-6789-abcd-ef0123456789"
type: string
type: object
CustomerOrgDisableRequestData:
description: Data object for a customer org disable request.
properties:
attributes:
$ref: "#/components/schemas/CustomerOrgDisableRequestAttributes"
id:
description: |-
Optional client-supplied identifier for the request. Useful for client-side
correlation; the server does not use this value.
example: "1"
type: string
type:
$ref: "#/components/schemas/CustomerOrgDisableType"
required:
- type
type: object
CustomerOrgDisableResponse:
description: Response describing the outcome of disabling the customer organization.
properties:
data:
$ref: "#/components/schemas/CustomerOrgDisableResponseData"
required:
- data
type: object
CustomerOrgDisableResponseAttributes:
description: Attributes describing the outcome of the disable action on the customer organization.
properties:
status:
description: Resulting lifecycle status of the organization after the disable action.
example: "disabled"
type: string
required:
- status
type: object
CustomerOrgDisableResponseData:
description: Data object returned after disabling the customer organization.
properties:
attributes:
$ref: "#/components/schemas/CustomerOrgDisableResponseAttributes"
id:
description: Identifier of the disabled organization.
example: "abcdef01-2345-6789-abcd-ef0123456789"
type: string
type:
$ref: "#/components/schemas/CustomerOrgDisableType"
required:
- type
- id
- attributes
type: object
CustomerOrgDisableType:
description: JSON:API resource type for a customer org disable action.
enum:
- customer_org_disable
example: "customer_org_disable"
type: string
x-enum-varnames:
- CUSTOMER_ORG_DISABLE
DORACustomTags:
description: A list of user-defined tags. The tags must follow the `key:value` pattern. Up to 100 may be added per event.
example:
Expand Down Expand Up @@ -108605,6 +108690,72 @@ paths:
operator: OR
permissions:
- user_app_keys
/api/v2/customer/org/disable:
post:
description: |-
Disable the Datadog organization associated with the authenticated user or API key.
The request body uses JSON:API format. If `org_id` or `org_uuid` are supplied, they
must match the authenticated org or the request is rejected. Successful calls disable
the org and return the resulting state from the downstream service. Requires the
`org_management` permission.
operationId: DisableCustomerOrg
requestBody:
content:
application/json:
examples:
default:
value:
data:
attributes:
org_id: 123
org_uuid: "abcdef01-2345-6789-abcd-ef0123456789"
id: "1"
type: "customer_org_disable"
schema:
$ref: "#/components/schemas/CustomerOrgDisableRequest"
required: true
responses:
"200":
content:
application/json:
examples:
default:
value:
data:
attributes:
status: "disabled"
id: "abcdef01-2345-6789-abcd-ef0123456789"
type: "customer_org_disable"
schema:
$ref: "#/components/schemas/CustomerOrgDisableResponse"
description: OK
"400":
content:
application/json:
schema:
$ref: "#/components/schemas/JSONAPIErrorResponse"
description: Bad Request
"401":
content:
application/json:
schema:
$ref: "#/components/schemas/JSONAPIErrorResponse"
description: Unauthorized
"403":
content:
application/json:
schema:
$ref: "#/components/schemas/JSONAPIErrorResponse"
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
summary: Disable the authenticated customer organization
tags:
- Customer Org
x-menu-order: 1
x-unstable: |-
**Note**: This endpoint is in preview and is subject to change.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
/api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards:
delete:
description: Delete dashboards from an existing dashboard list.
Expand Down Expand Up @@ -161455,6 +161606,10 @@ tags:
- description: |-
The Containers API allows you to query container data for your organization. See the [Container Monitoring page](https://docs.datadoghq.com/containers/) for more information.
name: Containers
- description: |-
Programmatic management of a customer's own Datadog organization. Use this API to perform
self-service organization lifecycle actions such as disabling the authenticated org.
name: Customer Org
- description: |-
Search, send, or delete events for DORA Metrics to measure and improve your software delivery performance. See the [DORA Metrics page](https://docs.datadoghq.com/dora_metrics/) for more information.

Expand Down
6 changes: 6 additions & 0 deletions data/api/v2/translate_actions.json
Original file line number Diff line number Diff line change
Expand Up @@ -1392,6 +1392,12 @@
"request_description": "",
"request_schema_description": "Request used to update an application key."
},
"DisableCustomerOrg": {
"description": "Disable the Datadog organization associated with the authenticated user or API key.\nThe request body uses JSON:API format. If `org_id` or `org_uuid` are supplied, they\nmust match the authenticated org or the request is rejected. Successful calls disable\nthe org and return the resulting state from the downstream service. Requires the\n`org_management` permission.",
"summary": "Disable the authenticated customer organization",
"request_description": "",
"request_schema_description": "Request payload for disabling the authenticated customer organization."
},
"DeleteDashboardListItems": {
"description": "Delete dashboards from an existing dashboard list.",
"summary": "Delete items from a dashboard list",
Expand Down
4 changes: 4 additions & 0 deletions data/api/v2/translate_tags.json
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,10 @@
"name": "Containers",
"description": "The Containers API allows you to query container data for your organization. See the [Container Monitoring page](https://docs.datadoghq.com/containers/) for more information."
},
"customer-org": {
"name": "Customer Org",
"description": "Programmatic management of a customer's own Datadog organization. Use this API to perform\nself-service organization lifecycle actions such as disabling the authenticated org."
},
"dora-metrics": {
"name": "DORA Metrics",
"description": "Search, send, or delete events for DORA Metrics to measure and improve your software delivery performance. See the [DORA Metrics page](https://docs.datadoghq.com/dora_metrics/) for more information.\n\n**Note**: DORA Metrics are not available in the US1-FED site."
Expand Down
Loading