From 2821829893e2cce3aac15e736d067932cc494500 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" <packages@datadoghq.com> Date: Thu, 5 Dec 2024 19:30:00 +0000 Subject: [PATCH] Regenerate client from commit de2bf103 of spec repo --- .apigentools-info | 8 +- config/_default/menus/api.en.yaml | 76 + content/en/api/latest/scim/_index.md | 3 + content/en/api/v2/scim/_index.md | 4 + content/en/api/v2/scim/examples.json | 380 ++++ data/api/v2/full_spec.yaml | 557 +++++ data/api/v2/full_spec_deref.json | 2505 ++++++++++++++++++++++- data/api/v2/translate_actions.json | 30 + data/api/v2/translate_tags.json | 4 + static/resources/json/full_spec_v2.json | 2505 ++++++++++++++++++++++- 10 files changed, 5932 insertions(+), 140 deletions(-) create mode 100644 content/en/api/latest/scim/_index.md create mode 100644 content/en/api/v2/scim/_index.md create mode 100644 content/en/api/v2/scim/examples.json diff --git a/.apigentools-info b/.apigentools-info index 2c45617d4663b..9f17fe512a20f 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2024-12-05 16:17:16.548283", - "spec_repo_commit": "843392e2" + "regenerated": "2024-12-05 19:29:42.570622", + "spec_repo_commit": "de2bf103" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2024-12-05 16:17:24.385771", - "spec_repo_commit": "843392e2" + "regenerated": "2024-12-05 19:29:50.661540", + "spec_repo_commit": "de2bf103" } } } \ No newline at end of file diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index c531b076edd7e..5bd58d6690e5b 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -7164,6 +7164,82 @@ menu: - ListRumMetrics unstable: [] order: 1 + - name: SCIM + url: /api/latest/scim/ + identifier: scim + generated: true + - name: Update SCIM group + url: '#update-scim-group' + identifier: scim-update-scim-group + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - UpdateSCIMGroup + unstable: [] + order: 6 + - name: Patch SCIM group + url: '#patch-scim-group' + identifier: scim-patch-scim-group + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - PatchSCIMGroup + unstable: [] + order: 4 + - name: Get SCIM group + url: '#get-scim-group' + identifier: scim-get-scim-group + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - GetSCIMGroup + unstable: [] + order: 3 + - name: Delete SCIM group + url: '#delete-scim-group' + identifier: scim-delete-scim-group + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - DeleteSCIMGroup + unstable: [] + order: 5 + - name: Create SCIM group + url: '#create-scim-group' + identifier: scim-create-scim-group + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - CreateSCIMGroup + unstable: [] + order: 2 + - name: List SCIM groups + url: '#list-scim-groups' + identifier: scim-list-scim-groups + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - ListSCIMGroups + unstable: [] + order: 1 - name: Sensitive Data Scanner url: /api/latest/sensitive-data-scanner/ identifier: sensitive-data-scanner diff --git a/content/en/api/latest/scim/_index.md b/content/en/api/latest/scim/_index.md new file mode 100644 index 0000000000000..0a143a6ca1d6e --- /dev/null +++ b/content/en/api/latest/scim/_index.md @@ -0,0 +1,3 @@ +--- +title: SCIM +--- diff --git a/content/en/api/v2/scim/_index.md b/content/en/api/v2/scim/_index.md new file mode 100644 index 0000000000000..11b0dd8d36f2c --- /dev/null +++ b/content/en/api/v2/scim/_index.md @@ -0,0 +1,4 @@ +--- +title: SCIM +headless: true +--- diff --git a/content/en/api/v2/scim/examples.json b/content/en/api/v2/scim/examples.json new file mode 100644 index 0000000000000..fbb1ebcd30173 --- /dev/null +++ b/content/en/api/v2/scim/examples.json @@ -0,0 +1,380 @@ +{ + "ListSCIMGroups": { + "responses": { + "200": { + "json": { + "Resources": [ + { + "displayName": "My test group", + "externalId": "346af543-e5ab-4855-937d-133231cd59ed", + "id": "0e80d350-9519-4771-9aa8-ce849fc36c20", + "members": [ + { + "$ref": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "display": "John Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6" + } + ], + "meta": { + "created": "2024-10-17T12:53:35.793Z", + "lastModified": "2024-10-19T12:53:35.793Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + } + ], + "itemsPerPage": "integer", + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "startIndex": "integer", + "totalResults": "integer" + }, + "html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> Resources</p>\n </div>\n <div class=\"col-2 column\"><p>[object]</p></div>\n <div class=\"col-6 column\"><p>List of SCIM groups matching the request criteria.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">displayName</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>A human-readable name for the group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">externalId</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>An identifier for the resource as defined by the provisioning client.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">id</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The identifier of the resource. Not required when creating a group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> members</p>\n </div>\n <div class=\"col-2 column\"><p>[object]</p></div>\n <div class=\"col-6 column\"><p>A list of members belonging to the team.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">$ref</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The URI corresponding to a SCIM resource that is a member of this group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">display</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Full name of the user.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>A label indicating the type of resource. Only supported value is "User".</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">value</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The identifier of the member of this group.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> meta</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Metadata associated with a SCIM group.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">created</p>\n </div>\n <div class=\"col-2 column\"><p>date-time</p></div>\n <div class=\"col-6 column\"><p>The date and time the group was created.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">lastModified</p>\n </div>\n <div class=\"col-2 column\"><p>date-time</p></div>\n <div class=\"col-6 column\"><p>The date and time the group was last changed.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">location</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>URL identifying the resource.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">resourceType</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Type of resource.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">schemas</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>SCIM group JSON Schemas.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">itemsPerPage</p>\n </div>\n <div class=\"col-2 column\"><p>int64</p></div>\n <div class=\"col-6 column\"><p>Number of SCIM groups returned per page.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">schemas</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>List response JSON Schemas.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">startIndex</p>\n </div>\n <div class=\"col-2 column\"><p>int64</p></div>\n <div class=\"col-6 column\"><p>Starting index of the SCIM groups for this page (1-indexed).</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">totalResults</p>\n </div>\n <div class=\"col-2 column\"><p>int64</p></div>\n <div class=\"col-6 column\"><p>Total number of SCIM groups matching the request criteria.</p></div>\n </div>\n \n </div>\n </div></div>" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateSCIMGroup": { + "responses": { + "201": { + "json": { + "displayName": "string", + "externalId": "string", + "id": "string", + "members": [ + { + "$ref": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "display": "John Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6" + } + ], + "meta": { + "created": "2024-10-17T12:53:35.793Z", + "lastModified": "2024-10-19T12:53:35.793Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">displayName</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>A human-readable name for the group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">externalId</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>An identifier for the resource as defined by the provisioning client.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">id</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The identifier of the resource. Not required when creating a group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> members</p>\n </div>\n <div class=\"col-2 column\"><p>[object]</p></div>\n <div class=\"col-6 column\"><p>Members of the SCIM group.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">$ref</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The URI corresponding to a SCIM resource that is a member of this group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">display</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>A human-readable name for the group member.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>A label indicating the type of resource.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">value</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The identifier of the member of this group.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> meta</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Metadata associated with a SCIM group.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">created</p>\n </div>\n <div class=\"col-2 column\"><p>date-time</p></div>\n <div class=\"col-6 column\"><p>The date and time the group was created.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">lastModified</p>\n </div>\n <div class=\"col-2 column\"><p>date-time</p></div>\n <div class=\"col-6 column\"><p>The date and time the group was last changed.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">location</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>URL identifying the resource.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">resourceType</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Type of resource.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">schemas</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>Input JSON Schemas.</p></div>\n </div>\n \n </div>\n </div></div>" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>" + } + }, + "request": { + "json_curl": {}, + "json": { + "displayName": "string", + "externalId": "string", + "id": "string", + "members": [ + { + "$ref": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "display": "John Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6" + } + ], + "meta": { + "created": "2024-10-17T12:53:35.793Z", + "lastModified": "2024-10-19T12:53:35.793Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">displayName</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>A human-readable name for the group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">externalId</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>An identifier for the resource as defined by the provisioning client.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">id</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The identifier of the resource. Not required when creating a group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> members</p>\n </div>\n <div class=\"col-2 column\"><p>[object]</p></div>\n <div class=\"col-6 column\"><p>Members of the SCIM group.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">$ref</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The URI corresponding to a SCIM resource that is a member of this group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">display</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>A human-readable name for the group member.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>A label indicating the type of resource.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">value</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The identifier of the member of this group.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> meta</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Metadata associated with a SCIM group.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">created</p>\n </div>\n <div class=\"col-2 column\"><p>date-time</p></div>\n <div class=\"col-6 column\"><p>The date and time the group was created.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">lastModified</p>\n </div>\n <div class=\"col-2 column\"><p>date-time</p></div>\n <div class=\"col-6 column\"><p>The date and time the group was last changed.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">location</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>URL identifying the resource.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">resourceType</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Type of resource.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">schemas</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>Input JSON Schemas.</p></div>\n </div>\n \n </div>\n </div></div>" + } + }, + "DeleteSCIMGroup": { + "responses": { + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetSCIMGroup": { + "responses": { + "200": { + "json": { + "displayName": "string", + "externalId": "string", + "id": "string", + "members": [ + { + "$ref": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "display": "John Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6" + } + ], + "meta": { + "created": "2024-10-17T12:53:35.793Z", + "lastModified": "2024-10-19T12:53:35.793Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">displayName</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>A human-readable name for the group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">externalId</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>An identifier for the resource as defined by the provisioning client.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">id</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The identifier of the resource. Not required when creating a group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> members</p>\n </div>\n <div class=\"col-2 column\"><p>[object]</p></div>\n <div class=\"col-6 column\"><p>Members of the SCIM group.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">$ref</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The URI corresponding to a SCIM resource that is a member of this group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">display</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>A human-readable name for the group member.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>A label indicating the type of resource.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">value</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The identifier of the member of this group.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> meta</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Metadata associated with a SCIM group.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">created</p>\n </div>\n <div class=\"col-2 column\"><p>date-time</p></div>\n <div class=\"col-6 column\"><p>The date and time the group was created.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">lastModified</p>\n </div>\n <div class=\"col-2 column\"><p>date-time</p></div>\n <div class=\"col-6 column\"><p>The date and time the group was last changed.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">location</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>URL identifying the resource.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">resourceType</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Type of resource.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">schemas</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>Input JSON Schemas.</p></div>\n </div>\n \n </div>\n </div></div>" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "PatchSCIMGroup": { + "responses": { + "200": { + "json": { + "displayName": "string", + "externalId": "string", + "id": "string", + "members": [ + { + "$ref": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "display": "John Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6" + } + ], + "meta": { + "created": "2024-10-17T12:53:35.793Z", + "lastModified": "2024-10-19T12:53:35.793Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">displayName</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>A human-readable name for the group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">externalId</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>An identifier for the resource as defined by the provisioning client.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">id</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The identifier of the resource. Not required when creating a group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> members</p>\n </div>\n <div class=\"col-2 column\"><p>[object]</p></div>\n <div class=\"col-6 column\"><p>Members of the SCIM group.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">$ref</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The URI corresponding to a SCIM resource that is a member of this group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">display</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>A human-readable name for the group member.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>A label indicating the type of resource.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">value</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The identifier of the member of this group.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> meta</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Metadata associated with a SCIM group.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">created</p>\n </div>\n <div class=\"col-2 column\"><p>date-time</p></div>\n <div class=\"col-6 column\"><p>The date and time the group was created.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">lastModified</p>\n </div>\n <div class=\"col-2 column\"><p>date-time</p></div>\n <div class=\"col-6 column\"><p>The date and time the group was last changed.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">location</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>URL identifying the resource.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">resourceType</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Type of resource.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">schemas</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>Input JSON Schemas.</p></div>\n </div>\n \n </div>\n </div></div>" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>" + } + }, + "request": { + "json_curl": {}, + "json": { + "Operations": [ + { + "op": "string", + "path": "members", + "value": "{\n \"displayName\": \"Real new group\",\n \"id\": \"80df3a9b-24f5-4ebf-9ba0-714455453621\"\n}" + } + ], + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ] + }, + "html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> Operations</p>\n </div>\n <div class=\"col-2 column\"><p>[object]</p></div>\n <div class=\"col-6 column\"><p>A list of update operations to be performed on a SCIM group.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">op</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>The operation to be performed. \nAllowed enum values: <code>add,replace,remove</code></p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">path</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>An attribute path describing the target of the operation.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">value</p>\n </div>\n <div class=\"col-2 column\"><p></p></div>\n <div class=\"col-6 column\"><p>JSON element containing the target values required to apply the patch operation.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">schemas</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>Input JSON Schemas</p></div>\n </div>\n \n </div>\n </div></div>" + } + }, + "UpdateSCIMGroup": { + "responses": { + "200": { + "json": { + "displayName": "string", + "externalId": "string", + "id": "string", + "members": [ + { + "$ref": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "display": "John Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6" + } + ], + "meta": { + "created": "2024-10-17T12:53:35.793Z", + "lastModified": "2024-10-19T12:53:35.793Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">displayName</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>A human-readable name for the group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">externalId</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>An identifier for the resource as defined by the provisioning client.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">id</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The identifier of the resource. Not required when creating a group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> members</p>\n </div>\n <div class=\"col-2 column\"><p>[object]</p></div>\n <div class=\"col-6 column\"><p>Members of the SCIM group.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">$ref</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The URI corresponding to a SCIM resource that is a member of this group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">display</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>A human-readable name for the group member.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>A label indicating the type of resource.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">value</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The identifier of the member of this group.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> meta</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Metadata associated with a SCIM group.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">created</p>\n </div>\n <div class=\"col-2 column\"><p>date-time</p></div>\n <div class=\"col-6 column\"><p>The date and time the group was created.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">lastModified</p>\n </div>\n <div class=\"col-2 column\"><p>date-time</p></div>\n <div class=\"col-6 column\"><p>The date and time the group was last changed.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">location</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>URL identifying the resource.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">resourceType</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Type of resource.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">schemas</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>Input JSON Schemas.</p></div>\n </div>\n \n </div>\n </div></div>" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>" + }, + "409": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>" + } + }, + "request": { + "json_curl": {}, + "json": { + "displayName": "string", + "externalId": "string", + "id": "string", + "members": [ + { + "$ref": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "display": "John Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6" + } + ], + "meta": { + "created": "2024-10-17T12:53:35.793Z", + "lastModified": "2024-10-19T12:53:35.793Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">displayName</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>A human-readable name for the group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">externalId</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>An identifier for the resource as defined by the provisioning client.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">id</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The identifier of the resource. Not required when creating a group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> members</p>\n </div>\n <div class=\"col-2 column\"><p>[object]</p></div>\n <div class=\"col-6 column\"><p>Members of the SCIM group.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">$ref</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The URI corresponding to a SCIM resource that is a member of this group.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">display</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>A human-readable name for the group member.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>A label indicating the type of resource.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">value</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The identifier of the member of this group.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> meta</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Metadata associated with a SCIM group.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">created</p>\n </div>\n <div class=\"col-2 column\"><p>date-time</p></div>\n <div class=\"col-6 column\"><p>The date and time the group was created.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">lastModified</p>\n </div>\n <div class=\"col-2 column\"><p>date-time</p></div>\n <div class=\"col-6 column\"><p>The date and time the group was last changed.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">location</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>URL identifying the resource.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">resourceType</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Type of resource.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">schemas</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>Input JSON Schemas.</p></div>\n </div>\n \n </div>\n </div></div>" + } + } +} \ No newline at end of file diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 786e862b33a28..480fe147bf68e 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -10282,6 +10282,158 @@ components: from the other indexes. type: string type: object + ExternalUserGroup: + description: Definition of a SCIM group. + example: + displayName: Group 1 + externalId: group1 + id: e43536e9-33fe-43f8-90b8-d3e39a7dd6ad + members: + - $ref: https://app.datadoghq.com/api/scim/v2/Users/d34a5f93-5690-4d3f-a293-f2ad5c7a82a4 + display: John Doe + type: User + value: d34a5f93-5690-4d3f-a293-f2ad5c7a82a4 + - $ref: https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6 + display: Jane Doe + type: User + value: 429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6 + meta: + created: '2024-11-22T15:05:52.055138963Z' + lastModified: '2024-11-22T15:05:52.055139017Z' + location: https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad + resourceType: Group + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + properties: + displayName: + description: A human-readable name for the group. + type: string + externalId: + description: An identifier for the resource as defined by the provisioning + client. + type: string + id: + description: The identifier of the resource. Not required when creating + a group. + type: string + members: + description: Members of the SCIM group. + items: + $ref: '#/components/schemas/ExternalUserGroupMembersItems' + type: array + meta: + $ref: '#/components/schemas/ExternalUserGroupMeta' + schemas: + description: Input JSON Schemas. + example: + - urn:ietf:params:scim:schemas:core:2.0:Group + items: + type: string + type: array + type: object + ExternalUserGroupMembersItems: + description: The definition of a member belonging to a SCIM group. + properties: + $ref: + description: The URI corresponding to a SCIM resource that is a member of + this group. + example: https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6 + type: string + display: + description: A human-readable name for the group member. + example: John Doe + type: string + type: + description: A label indicating the type of resource. + example: User + type: string + value: + description: The identifier of the member of this group. + example: 429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6 + type: string + type: object + ExternalUserGroupMeta: + description: Metadata associated with a SCIM group. + properties: + created: + description: The date and time the group was created. + example: 2024-10-17 12:53:35.793883+00:00 + format: date-time + type: string + lastModified: + description: The date and time the group was last changed. + example: 2024-10-19 12:53:35.793883+00:00 + format: date-time + type: string + location: + description: URL identifying the resource. + example: https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6 + type: string + resourceType: + description: Type of resource. + example: Group + type: string + type: object + ExternalUserGroupPatchRequest: + description: Request object for patching a SCIM group. + example: + Operations: + - op: replace + path: None + value: + displayName: Real new group + id: e43536e9-33fe-43f8-90b8-d3e39a7dd6ad + - op: add + path: None + value: + members: + - $ref: https://app.datadoghq.com/api/scim/v2/Users/f85e3868-ad7b-47e3-a8a9-ff1eade2bbf9 + displayName: Bob Smith + value: f85e3868-ad7b-47e3-a8a9-ff1eade2bbf9 + - op: remove + path: members[value eq "fddf0cf2-9b60-11ef-ad4b-d6754a54a839"] + value: null + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + properties: + Operations: + description: A list of update operations to be performed on a SCIM group. + items: + $ref: '#/components/schemas/ExternalUserGroupPatchRequestOperationsItems' + type: array + schemas: + description: Input JSON Schemas + example: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + items: + type: string + type: array + type: object + ExternalUserGroupPatchRequestOperationsItems: + description: The definition of an individual patch operation in a patch request. + properties: + op: + $ref: '#/components/schemas/ExternalUserGroupPatchRequestOperationsItemsOp' + path: + description: An attribute path describing the target of the operation. + example: members + type: string + value: + description: JSON element containing the target values required to apply + the patch operation. + example: "{\n \"displayName\": \"Real new group\",\n \"id\": \"80df3a9b-24f5-4ebf-9ba0-714455453621\"\n}" + type: object + ExternalUserGroupPatchRequestOperationsItemsOp: + description: The operation to be performed. + enum: + - add + - replace + - remove + type: string + x-enum-varnames: + - ADD + - REPLACE + - REMOVE FastlyAccounResponseAttributes: description: Attributes object of a Fastly account. properties: @@ -14114,6 +14266,140 @@ components: description: Current link. type: string type: object + ListExternalUserGroupResponse: + description: List SCIM groups response object. + example: + Resources: + - displayName: Group 1 + externalId: group1 + id: e43536e9-33fe-43f8-90b8-d3e39a7dd6ad + members: + - $ref: https://app.datadoghq.com/api/scim/v2/Users/d34a5f93-5690-4d3f-a293-f2ad5c7a82a4 + display: John Doe + type: User + value: d34a5f93-5690-4d3f-a293-f2ad5c7a82a4 + - $ref: https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6 + display: Jane Doe + type: User + value: 429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6 + meta: + created: '2024-11-22T15:05:52.055138963Z' + lastModified: '2024-11-22T15:05:52.055139017Z' + location: https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad + resourceType: Group + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + - displayName: Group 2 + externalId: group2 + id: 79ef0d28-f257-4829-97e6-d23d2a26cb1a + members: + - $ref: https://app.datadoghq.com/api/scim/v2/Users/29da9fb7-8fca-4e87-bf58-86652253deae + display: Alice Smith + type: User + value: 29da9fb7-8fca-4e87-bf58-86652253deae + - $ref: https://app.datadoghq.com/api/scim/v2/Users/f85e3868-ad7b-47e3-a8a9-ff1eade2bbf9 + display: Bob Smith + type: User + value: f85e3868-ad7b-47e3-a8a9-ff1eade2bbf9 + meta: + created: '2024-11-22T15:05:52.055139748Z' + lastModified: '2024-11-22T15:05:52.055139813Z' + location: https://app.datadoghq.com/api/scim/v2/Groups/79ef0d28-f257-4829-97e6-d23d2a26cb1a + resourceType: Group + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + itemsPerPage: 2 + schemas: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + startIndex: 1 + totalResults: 2 + properties: + Resources: + description: List of SCIM groups matching the request criteria. + items: + $ref: '#/components/schemas/ListExternalUserGroupResponseResourcesItems' + type: array + itemsPerPage: + description: Number of SCIM groups returned per page. + format: int64 + maximum: 4294967295 + minimum: 0 + type: integer + schemas: + description: List response JSON Schemas. + example: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + items: + type: string + type: array + startIndex: + description: Starting index of the SCIM groups for this page (1-indexed). + format: int64 + maximum: 4294967295 + minimum: 0 + type: integer + totalResults: + description: Total number of SCIM groups matching the request criteria. + format: int64 + maximum: 4294967295 + minimum: 0 + type: integer + type: object + ListExternalUserGroupResponseResourcesItems: + description: SCIM resources returned in response to a List SCIM groups request. + properties: + displayName: + description: A human-readable name for the group. + example: My test group + type: string + externalId: + description: An identifier for the resource as defined by the provisioning + client. + example: 346af543-e5ab-4855-937d-133231cd59ed + type: string + id: + description: The identifier of the resource. Not required when creating + a group. + example: 0e80d350-9519-4771-9aa8-ce849fc36c20 + type: string + members: + description: A list of members belonging to the team. + items: + $ref: '#/components/schemas/ListExternalUserGroupResponseResourcesItemsMembersItems' + type: array + meta: + $ref: '#/components/schemas/ExternalUserGroupMeta' + schemas: + description: SCIM group JSON Schemas. + example: + - urn:ietf:params:scim:schemas:core:2.0:Group + items: + type: string + type: array + type: object + ListExternalUserGroupResponseResourcesItemsMembersItems: + description: The definition of a member belonging to a group in the List SCIM + groups response. + properties: + $ref: + description: The URI corresponding to a SCIM resource that is a member of + this group. + example: https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6 + type: string + display: + description: Full name of the user. + example: John Doe + type: string + type: + description: A label indicating the type of resource. Only supported value + is "User". + example: User + type: string + value: + description: The identifier of the member of this group. + example: 429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6 + type: string + type: object ListFindingsData: description: Array of findings. items: @@ -41305,6 +41591,275 @@ paths: - org_management x-undo: type: idempotent + /api/v2/scim/Groups: + get: + description: 'List SCIM groups in the organization. + + Results are paginated by `startIndex` and `count` parameters. + + Results can be narrowed down by the `filter` parameter.' + operationId: ListSCIMGroups + parameters: + - description: Specifies the start index to fetch the results (1-indexed). + in: query + name: startIndex + required: false + schema: + default: 1 + example: 1 + format: int64 + type: integer + - description: Specifies the number of groups to be returned. + in: query + name: count + required: false + schema: + default: 20 + example: 20 + format: int64 + type: integer + - description: 'Specifies the url encoded filter to use to narrow down the results. + + Filters can be in the form of `displayName eq <group name>` or `externalId + eq <external id of group>` + + or `id eq <group id> and members eq <user uuid>` or `members eq <user uuid> + and id eq <group id>`.' + in: query + name: filter + required: false + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListExternalUserGroupResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - AuthZ: + - user_access_invite + - user_access_manage + summary: List SCIM groups + tags: + - SCIM + x-menu-order: 1 + x-permission: + operator: AND + permissions: + - user_access_invite + - user_access_manage + x-undo: + type: safe + post: + description: 'Create a new SCIM group. + + The group may contain members.' + operationId: CreateSCIMGroup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalUserGroup' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalUserGroup' + description: Created + '400': + $ref: '#/components/responses/BadRequestResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - AuthZ: + - user_access_invite + - user_access_manage + summary: Create SCIM group + tags: + - SCIM + x-menu-order: 2 + x-permission: + operator: AND + permissions: + - user_access_invite + - user_access_manage + x-undo: + operationId: DeleteSCIMGroup + parameters: + - name: group_id + source: <RESPONSE_PATH> + type: unsafe + /api/v2/scim/Groups/{group_id}: + delete: + description: Delete the SCIM group with the given `group_id`. + operationId: DeleteSCIMGroup + parameters: + - description: None + in: path + name: group_id + required: true + schema: + type: string + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - AuthZ: + - user_access_invite + - user_access_manage + summary: Delete SCIM group + tags: + - SCIM + x-menu-order: 5 + x-permission: + operator: AND + permissions: + - user_access_invite + - user_access_manage + x-undo: + type: idempotent + get: + description: Get a single SCIM group using the `group_id`. + operationId: GetSCIMGroup + parameters: + - description: None + in: path + name: group_id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalUserGroup' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - AuthZ: + - user_access_invite + - user_access_manage + summary: Get SCIM group + tags: + - SCIM + x-menu-order: 3 + x-permission: + operator: AND + permissions: + - user_access_invite + - user_access_manage + x-undo: + type: safe + patch: + description: Patch the SCIM group with the given `group_id`. + operationId: PatchSCIMGroup + parameters: + - description: None + in: path + name: group_id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalUserGroupPatchRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalUserGroup' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - AuthZ: + - user_access_invite + - user_access_manage + summary: Patch SCIM group + tags: + - SCIM + x-menu-order: 4 + x-permission: + operator: AND + permissions: + - user_access_invite + - user_access_manage + x-undo: + type: idempotent + put: + description: Update the SCIM group with the given `group_id`. + operationId: UpdateSCIMGroup + parameters: + - description: None + in: path + name: group_id + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalUserGroup' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalUserGroup' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '409': + $ref: '#/components/responses/ConflictResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - AuthZ: + - user_access_invite + - user_access_manage + summary: Update SCIM group + tags: + - SCIM + x-menu-order: 6 + x-permission: + operator: AND + permissions: + - user_access_invite + - user_access_manage + x-undo: + type: idempotent /api/v2/scorecard/outcomes: get: description: Fetches all rule outcomes. @@ -47796,6 +48351,8 @@ tags: description: Find out more at url: https://docs.datadoghq.com/real_user_monitoring/platform/generate_metrics/ name: Rum Metrics +- description: Provision Datadog teams using SCIM group APIs. + name: SCIM - description: Create and manage your security rules, signals, filters, and more. See the [Datadog Security page](https://docs.datadoghq.com/security/) for more information. diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index 9f1b6d38e2f37..f4b3b9613e3b2 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -56158,6 +56158,299 @@ }, "type": "object" }, + "ExternalUserGroup": { + "description": "Definition of a SCIM group.", + "example": { + "displayName": "Group 1", + "externalId": "group1", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "members": [ + { + "display": "John Doe", + "type": "User", + "value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/0" + }, + { + "display": "Jane Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "properties": { + "displayName": { + "description": "A human-readable name for the group.", + "type": "string" + }, + "externalId": { + "description": "An identifier for the resource as defined by the provisioning client.", + "type": "string" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a group.", + "type": "string" + }, + "members": { + "description": "Members of the SCIM group.", + "items": { + "description": "The definition of a member belonging to a SCIM group.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "A human-readable name for the group member.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource.", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "Input JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ExternalUserGroupMembersItems": { + "description": "The definition of a member belonging to a SCIM group.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "A human-readable name for the group member.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource.", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "ExternalUserGroupMeta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "ExternalUserGroupPatchRequest": { + "description": "Request object for patching a SCIM group.", + "example": { + "Operations": [ + { + "op": "replace", + "path": "None", + "value": { + "displayName": "Real new group", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad" + } + }, + { + "op": "add", + "path": "None", + "value": { + "members": [ + { + "displayName": "Bob Smith", + "value": "f85e3868-ad7b-47e3-a8a9-ff1eade2bbf9", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/patch/requestBody/content/application~1json/schema/example/Operations/1/value/members/0" + } + ] + } + }, + { + "op": "remove", + "path": "members[value eq \"fddf0cf2-9b60-11ef-ad4b-d6754a54a839\"]", + "value": null + } + ], + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ] + }, + "properties": { + "Operations": { + "description": "A list of update operations to be performed on a SCIM group.", + "items": { + "description": "The definition of an individual patch operation in a patch request.", + "properties": { + "op": { + "description": "The operation to be performed.", + "enum": [ + "add", + "replace", + "remove" + ], + "type": "string", + "x-enum-varnames": [ + "ADD", + "REPLACE", + "REMOVE" + ] + }, + "path": { + "description": "An attribute path describing the target of the operation.", + "example": "members", + "type": "string" + }, + "value": { + "description": "JSON element containing the target values required to apply the patch operation.", + "example": "{\n \"displayName\": \"Real new group\",\n \"id\": \"80df3a9b-24f5-4ebf-9ba0-714455453621\"\n}" + } + }, + "type": "object" + }, + "type": "array" + }, + "schemas": { + "description": "Input JSON Schemas", + "example": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ExternalUserGroupPatchRequestOperationsItems": { + "description": "The definition of an individual patch operation in a patch request.", + "properties": { + "op": { + "description": "The operation to be performed.", + "enum": [ + "add", + "replace", + "remove" + ], + "type": "string", + "x-enum-varnames": [ + "ADD", + "REPLACE", + "REMOVE" + ] + }, + "path": { + "description": "An attribute path describing the target of the operation.", + "example": "members", + "type": "string" + }, + "value": { + "description": "JSON element containing the target values required to apply the patch operation.", + "example": "{\n \"displayName\": \"Real new group\",\n \"id\": \"80df3a9b-24f5-4ebf-9ba0-714455453621\"\n}" + } + }, + "type": "object" + }, + "ExternalUserGroupPatchRequestOperationsItemsOp": { + "description": "The operation to be performed.", + "enum": [ + "add", + "replace", + "remove" + ], + "type": "string", + "x-enum-varnames": [ + "ADD", + "REPLACE", + "REMOVE" + ] + }, "FastlyAccounResponseAttributes": { "description": "Attributes object of a Fastly account.", "properties": { @@ -93460,6 +93753,317 @@ }, "type": "object" }, + "ListExternalUserGroupResponse": { + "description": "List SCIM groups response object.", + "example": { + "Resources": [ + { + "displayName": "Group 1", + "externalId": "group1", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "members": [ + { + "display": "John Doe", + "type": "User", + "value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4", + "$ref": "#/paths/~1api~1v2~1scim~1Groups/get/responses/200/content/application~1json/schema/example/Resources/0/members/0" + }, + { + "display": "Jane Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "$ref": "#/paths/~1api~1v2~1scim~1Groups/get/responses/200/content/application~1json/schema/example/Resources/0/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + { + "displayName": "Group 2", + "externalId": "group2", + "id": "79ef0d28-f257-4829-97e6-d23d2a26cb1a", + "members": [ + { + "display": "Alice Smith", + "type": "User", + "value": "29da9fb7-8fca-4e87-bf58-86652253deae", + "$ref": "#/paths/~1api~1v2~1scim~1Groups/get/responses/200/content/application~1json/schema/example/Resources/1/members/0" + }, + { + "display": "Bob Smith", + "type": "User", + "value": "f85e3868-ad7b-47e3-a8a9-ff1eade2bbf9", + "$ref": "#/paths/~1api~1v2~1scim~1Groups/get/responses/200/content/application~1json/schema/example/Resources/1/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055139748Z", + "lastModified": "2024-11-22T15:05:52.055139813Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/79ef0d28-f257-4829-97e6-d23d2a26cb1a", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + } + ], + "itemsPerPage": 2, + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "startIndex": 1, + "totalResults": 2 + }, + "properties": { + "Resources": { + "description": "List of SCIM groups matching the request criteria.", + "items": { + "description": "SCIM resources returned in response to a List SCIM groups request.", + "properties": { + "displayName": { + "description": "A human-readable name for the group.", + "example": "My test group", + "type": "string" + }, + "externalId": { + "description": "An identifier for the resource as defined by the provisioning client.", + "example": "346af543-e5ab-4855-937d-133231cd59ed", + "type": "string" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a group.", + "example": "0e80d350-9519-4771-9aa8-ce849fc36c20", + "type": "string" + }, + "members": { + "description": "A list of members belonging to the team.", + "items": { + "description": "The definition of a member belonging to a group in the List SCIM groups response.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "Full name of the user.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource. Only supported value is \"User\".", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "SCIM group JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "itemsPerPage": { + "description": "Number of SCIM groups returned per page.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + }, + "schemas": { + "description": "List response JSON Schemas.", + "example": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "startIndex": { + "description": "Starting index of the SCIM groups for this page (1-indexed).", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + }, + "totalResults": { + "description": "Total number of SCIM groups matching the request criteria.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "ListExternalUserGroupResponseResourcesItems": { + "description": "SCIM resources returned in response to a List SCIM groups request.", + "properties": { + "displayName": { + "description": "A human-readable name for the group.", + "example": "My test group", + "type": "string" + }, + "externalId": { + "description": "An identifier for the resource as defined by the provisioning client.", + "example": "346af543-e5ab-4855-937d-133231cd59ed", + "type": "string" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a group.", + "example": "0e80d350-9519-4771-9aa8-ce849fc36c20", + "type": "string" + }, + "members": { + "description": "A list of members belonging to the team.", + "items": { + "description": "The definition of a member belonging to a group in the List SCIM groups response.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "Full name of the user.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource. Only supported value is \"User\".", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "SCIM group JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListExternalUserGroupResponseResourcesItemsMembersItems": { + "description": "The definition of a member belonging to a group in the List SCIM groups response.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "Full name of the user.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource. Only supported value is \"User\".", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, "ListFindingsData": { "description": "Array of findings.", "items": { @@ -297925,35 +298529,1536 @@ } } }, - "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": "Not Authorized" + "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": "Not Authorized" + }, + "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": [] + } + ], + "summary": "Search RUM events", + "tags": [ + "RUM" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 1, + "x-pagination": { + "cursorParam": "body.page.cursor", + "cursorPath": "meta.page.after", + "limitParam": "body.page.limit", + "resultsPath": "data" + }, + "x-permission": { + "operator": "OPEN", + "permissions": [] + }, + "x-undo": { + "type": "safe" + } + } + }, + "/api/v2/saml_configurations/idp_metadata": { + "post": { + "description": "Endpoint for uploading IdP metadata for SAML setup.\n\nUse this endpoint to upload or replace IdP metadata for SAML login configuration.", + "operationId": "UploadIdPMetadata", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "description": "The form data submitted to upload IdP metadata", + "properties": { + "idp_file": { + "description": "The IdP metadata XML file", + "format": "binary", + "type": "string", + "x-mimetype": "application/xml" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "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" + } + }, + "summary": "Upload IdP metadata", + "tags": [ + "Organizations" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 1, + "x-permission": { + "operator": "OR", + "permissions": [ + "org_management" + ] + }, + "x-undo": { + "type": "idempotent" + } + } + }, + "/api/v2/scim/Groups": { + "get": { + "description": "List SCIM groups in the organization.\nResults are paginated by `startIndex` and `count` parameters.\nResults can be narrowed down by the `filter` parameter.", + "operationId": "ListSCIMGroups", + "parameters": [ + { + "description": "Specifies the start index to fetch the results (1-indexed).", + "in": "query", + "name": "startIndex", + "required": false, + "schema": { + "default": 1, + "example": 1, + "format": "int64", + "type": "integer" + } + }, + { + "description": "Specifies the number of groups to be returned.", + "in": "query", + "name": "count", + "required": false, + "schema": { + "default": 20, + "example": 20, + "format": "int64", + "type": "integer" + } + }, + { + "description": "Specifies the url encoded filter to use to narrow down the results.\nFilters can be in the form of `displayName eq <group name>` or `externalId eq <external id of group>`\nor `id eq <group id> and members eq <user uuid>` or `members eq <user uuid> and id eq <group id>`.", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "List SCIM groups response object.", + "example": { + "Resources": [ + { + "displayName": "Group 1", + "externalId": "group1", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "members": [ + { + "display": "John Doe", + "type": "User", + "value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4", + "$ref": "#/paths/~1api~1v2~1scim~1Groups/get/responses/200/content/application~1json/schema/example/Resources/0/members/0" + }, + { + "display": "Jane Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "$ref": "#/paths/~1api~1v2~1scim~1Groups/get/responses/200/content/application~1json/schema/example/Resources/0/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + { + "displayName": "Group 2", + "externalId": "group2", + "id": "79ef0d28-f257-4829-97e6-d23d2a26cb1a", + "members": [ + { + "display": "Alice Smith", + "type": "User", + "value": "29da9fb7-8fca-4e87-bf58-86652253deae", + "$ref": "#/paths/~1api~1v2~1scim~1Groups/get/responses/200/content/application~1json/schema/example/Resources/1/members/0" + }, + { + "display": "Bob Smith", + "type": "User", + "value": "f85e3868-ad7b-47e3-a8a9-ff1eade2bbf9", + "$ref": "#/paths/~1api~1v2~1scim~1Groups/get/responses/200/content/application~1json/schema/example/Resources/1/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055139748Z", + "lastModified": "2024-11-22T15:05:52.055139813Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/79ef0d28-f257-4829-97e6-d23d2a26cb1a", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + } + ], + "itemsPerPage": 2, + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "startIndex": 1, + "totalResults": 2 + }, + "properties": { + "Resources": { + "description": "List of SCIM groups matching the request criteria.", + "items": { + "description": "SCIM resources returned in response to a List SCIM groups request.", + "properties": { + "displayName": { + "description": "A human-readable name for the group.", + "example": "My test group", + "type": "string" + }, + "externalId": { + "description": "An identifier for the resource as defined by the provisioning client.", + "example": "346af543-e5ab-4855-937d-133231cd59ed", + "type": "string" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a group.", + "example": "0e80d350-9519-4771-9aa8-ce849fc36c20", + "type": "string" + }, + "members": { + "description": "A list of members belonging to the team.", + "items": { + "description": "The definition of a member belonging to a group in the List SCIM groups response.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "Full name of the user.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource. Only supported value is \"User\".", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "SCIM group JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "itemsPerPage": { + "description": "Number of SCIM groups returned per page.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + }, + "schemas": { + "description": "List response JSON Schemas.", + "example": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "startIndex": { + "description": "Starting index of the SCIM groups for this page (1-indexed).", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + }, + "totalResults": { + "description": "Total number of SCIM groups matching the request criteria.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + } + }, + "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" + }, + "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": [ + { + "AuthZ": [ + "user_access_invite", + "user_access_manage" + ] + } + ], + "summary": "List SCIM groups", + "tags": [ + "SCIM" + ], + "x-menu-order": 1, + "x-permission": { + "operator": "AND", + "permissions": [ + "user_access_invite", + "user_access_manage" + ] + }, + "x-undo": { + "type": "safe" + } + }, + "post": { + "description": "Create a new SCIM group.\nThe group may contain members.", + "operationId": "CreateSCIMGroup", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Definition of a SCIM group.", + "example": { + "displayName": "Group 1", + "externalId": "group1", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "members": [ + { + "display": "John Doe", + "type": "User", + "value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/0" + }, + { + "display": "Jane Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "properties": { + "displayName": { + "description": "A human-readable name for the group.", + "type": "string" + }, + "externalId": { + "description": "An identifier for the resource as defined by the provisioning client.", + "type": "string" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a group.", + "type": "string" + }, + "members": { + "description": "Members of the SCIM group.", + "items": { + "description": "The definition of a member belonging to a SCIM group.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "A human-readable name for the group member.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource.", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "Input JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Definition of a SCIM group.", + "example": { + "displayName": "Group 1", + "externalId": "group1", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "members": [ + { + "display": "John Doe", + "type": "User", + "value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/0" + }, + { + "display": "Jane Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "properties": { + "displayName": { + "description": "A human-readable name for the group.", + "type": "string" + }, + "externalId": { + "description": "An identifier for the resource as defined by the provisioning client.", + "type": "string" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a group.", + "type": "string" + }, + "members": { + "description": "Members of the SCIM group.", + "items": { + "description": "The definition of a member belonging to a SCIM group.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "A human-readable name for the group member.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource.", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "Input JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "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" + }, + "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": [ + { + "AuthZ": [ + "user_access_invite", + "user_access_manage" + ] + } + ], + "summary": "Create SCIM group", + "tags": [ + "SCIM" + ], + "x-menu-order": 2, + "x-permission": { + "operator": "AND", + "permissions": [ + "user_access_invite", + "user_access_manage" + ] + }, + "x-undo": { + "operationId": "DeleteSCIMGroup", + "parameters": [ + { + "name": "group_id", + "source": "<RESPONSE_PATH>" + } + ], + "type": "unsafe" + } + } + }, + "/api/v2/scim/Groups/{group_id}": { + "delete": { + "description": "Delete the SCIM group with the given `group_id`.", + "operationId": "DeleteSCIMGroup", + "parameters": [ + { + "description": "None", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "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" + }, + "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": [ + { + "AuthZ": [ + "user_access_invite", + "user_access_manage" + ] + } + ], + "summary": "Delete SCIM group", + "tags": [ + "SCIM" + ], + "x-menu-order": 5, + "x-permission": { + "operator": "AND", + "permissions": [ + "user_access_invite", + "user_access_manage" + ] + }, + "x-undo": { + "type": "idempotent" + } + }, + "get": { + "description": "Get a single SCIM group using the `group_id`.", + "operationId": "GetSCIMGroup", + "parameters": [ + { + "description": "None", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Definition of a SCIM group.", + "example": { + "displayName": "Group 1", + "externalId": "group1", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "members": [ + { + "display": "John Doe", + "type": "User", + "value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/0" + }, + { + "display": "Jane Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "properties": { + "displayName": { + "description": "A human-readable name for the group.", + "type": "string" + }, + "externalId": { + "description": "An identifier for the resource as defined by the provisioning client.", + "type": "string" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a group.", + "type": "string" + }, + "members": { + "description": "Members of the SCIM group.", + "items": { + "description": "The definition of a member belonging to a SCIM group.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "A human-readable name for the group member.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource.", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "Input JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "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" + }, + "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": [ + { + "AuthZ": [ + "user_access_invite", + "user_access_manage" + ] + } + ], + "summary": "Get SCIM group", + "tags": [ + "SCIM" + ], + "x-menu-order": 3, + "x-permission": { + "operator": "AND", + "permissions": [ + "user_access_invite", + "user_access_manage" + ] + }, + "x-undo": { + "type": "safe" + } + }, + "patch": { + "description": "Patch the SCIM group with the given `group_id`.", + "operationId": "PatchSCIMGroup", + "parameters": [ + { + "description": "None", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request object for patching a SCIM group.", + "example": { + "Operations": [ + { + "op": "replace", + "path": "None", + "value": { + "displayName": "Real new group", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad" + } + }, + { + "op": "add", + "path": "None", + "value": { + "members": [ + { + "displayName": "Bob Smith", + "value": "f85e3868-ad7b-47e3-a8a9-ff1eade2bbf9", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/patch/requestBody/content/application~1json/schema/example/Operations/1/value/members/0" + } + ] + } + }, + { + "op": "remove", + "path": "members[value eq \"fddf0cf2-9b60-11ef-ad4b-d6754a54a839\"]", + "value": null + } + ], + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ] + }, + "properties": { + "Operations": { + "description": "A list of update operations to be performed on a SCIM group.", + "items": { + "description": "The definition of an individual patch operation in a patch request.", + "properties": { + "op": { + "description": "The operation to be performed.", + "enum": [ + "add", + "replace", + "remove" + ], + "type": "string", + "x-enum-varnames": [ + "ADD", + "REPLACE", + "REMOVE" + ] + }, + "path": { + "description": "An attribute path describing the target of the operation.", + "example": "members", + "type": "string" + }, + "value": { + "description": "JSON element containing the target values required to apply the patch operation.", + "example": "{\n \"displayName\": \"Real new group\",\n \"id\": \"80df3a9b-24f5-4ebf-9ba0-714455453621\"\n}" + } + }, + "type": "object" + }, + "type": "array" + }, + "schemas": { + "description": "Input JSON Schemas", + "example": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Definition of a SCIM group.", + "example": { + "displayName": "Group 1", + "externalId": "group1", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "members": [ + { + "display": "John Doe", + "type": "User", + "value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/0" + }, + { + "display": "Jane Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "properties": { + "displayName": { + "description": "A human-readable name for the group.", + "type": "string" + }, + "externalId": { + "description": "An identifier for the resource as defined by the provisioning client.", + "type": "string" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a group.", + "type": "string" + }, + "members": { + "description": "Members of the SCIM group.", + "items": { + "description": "The definition of a member belonging to a SCIM group.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "A human-readable name for the group member.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource.", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "Input JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "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" + }, + "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": { @@ -297986,49 +300091,155 @@ }, "security": [ { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [] + "AuthZ": [ + "user_access_invite", + "user_access_manage" + ] } ], - "summary": "Search RUM events", + "summary": "Patch SCIM group", "tags": [ - "RUM" + "SCIM" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 1, - "x-pagination": { - "cursorParam": "body.page.cursor", - "cursorPath": "meta.page.after", - "limitParam": "body.page.limit", - "resultsPath": "data" - }, + "x-menu-order": 4, "x-permission": { - "operator": "OPEN", - "permissions": [] + "operator": "AND", + "permissions": [ + "user_access_invite", + "user_access_manage" + ] }, "x-undo": { - "type": "safe" + "type": "idempotent" } - } - }, - "/api/v2/saml_configurations/idp_metadata": { - "post": { - "description": "Endpoint for uploading IdP metadata for SAML setup.\n\nUse this endpoint to upload or replace IdP metadata for SAML login configuration.", - "operationId": "UploadIdPMetadata", + }, + "put": { + "description": "Update the SCIM group with the given `group_id`.", + "operationId": "UpdateSCIMGroup", + "parameters": [ + { + "description": "None", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { - "multipart/form-data": { + "application/json": { "schema": { - "description": "The form data submitted to upload IdP metadata", + "description": "Definition of a SCIM group.", + "example": { + "displayName": "Group 1", + "externalId": "group1", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "members": [ + { + "display": "John Doe", + "type": "User", + "value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/0" + }, + { + "display": "Jane Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, "properties": { - "idp_file": { - "description": "The IdP metadata XML file", - "format": "binary", - "type": "string", - "x-mimetype": "application/xml" + "displayName": { + "description": "A human-readable name for the group.", + "type": "string" + }, + "externalId": { + "description": "An identifier for the resource as defined by the provisioning client.", + "type": "string" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a group.", + "type": "string" + }, + "members": { + "description": "Members of the SCIM group.", + "items": { + "description": "The definition of a member belonging to a SCIM group.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "A human-readable name for the group member.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource.", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "Input JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -298039,6 +300250,124 @@ }, "responses": { "200": { + "content": { + "application/json": { + "schema": { + "description": "Definition of a SCIM group.", + "example": { + "displayName": "Group 1", + "externalId": "group1", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "members": [ + { + "display": "John Doe", + "type": "User", + "value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/0" + }, + { + "display": "Jane Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "properties": { + "displayName": { + "description": "A human-readable name for the group.", + "type": "string" + }, + "externalId": { + "description": "An identifier for the resource as defined by the provisioning client.", + "type": "string" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a group.", + "type": "string" + }, + "members": { + "description": "Members of the SCIM group.", + "items": { + "description": "The definition of a member belonging to a SCIM group.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "A human-readable name for the group member.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource.", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "Input JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, "description": "OK" }, "400": { @@ -298069,7 +300398,7 @@ }, "description": "Bad Request" }, - "403": { + "404": { "content": { "application/json": { "schema": { @@ -298095,7 +300424,35 @@ } } }, - "description": "Forbidden" + "description": "Not Found" + }, + "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": "Conflict" }, "429": { "content": { @@ -298126,16 +300483,24 @@ "description": "Too many requests" } }, - "summary": "Upload IdP metadata", + "security": [ + { + "AuthZ": [ + "user_access_invite", + "user_access_manage" + ] + } + ], + "summary": "Update SCIM group", "tags": [ - "Organizations" + "SCIM" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 1, + "x-menu-order": 6, "x-permission": { - "operator": "OR", + "operator": "AND", "permissions": [ - "org_management" + "user_access_invite", + "user_access_manage" ] }, "x-undo": { @@ -358169,6 +360534,10 @@ }, "name": "Rum Metrics" }, + { + "description": "Provision Datadog teams using SCIM group APIs.", + "name": "SCIM" + }, { "description": "Create and manage your security rules, signals, filters, and more. See the [Datadog Security page](https://docs.datadoghq.com/security/) for more information.", "name": "Security Monitoring" diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index 34a8d51755a85..a5ee97819ac89 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -1375,6 +1375,36 @@ "request_description": "", "request_schema_description": "The form data submitted to upload IdP metadata" }, + "ListSCIMGroups": { + "description": "List SCIM groups in the organization.\nResults are paginated by `startIndex` and `count` parameters.\nResults can be narrowed down by the `filter` parameter.", + "summary": "List SCIM groups" + }, + "CreateSCIMGroup": { + "description": "Create a new SCIM group.\nThe group may contain members.", + "summary": "Create SCIM group", + "request_description": "", + "request_schema_description": "Definition of a SCIM group." + }, + "DeleteSCIMGroup": { + "description": "Delete the SCIM group with the given `group_id`.", + "summary": "Delete SCIM group" + }, + "GetSCIMGroup": { + "description": "Get a single SCIM group using the `group_id`.", + "summary": "Get SCIM group" + }, + "PatchSCIMGroup": { + "description": "Patch the SCIM group with the given `group_id`.", + "summary": "Patch SCIM group", + "request_description": "", + "request_schema_description": "Request object for patching a SCIM group." + }, + "UpdateSCIMGroup": { + "description": "Update the SCIM group with the given `group_id`.", + "summary": "Update SCIM group", + "request_description": "", + "request_schema_description": "Definition of a SCIM group." + }, "ListScorecardOutcomes": { "description": "Fetches all rule outcomes.", "summary": "List all rule outcomes" diff --git a/data/api/v2/translate_tags.json b/data/api/v2/translate_tags.json index 9fd118dcd7f3f..3a78b7f1fbbc3 100644 --- a/data/api/v2/translate_tags.json +++ b/data/api/v2/translate_tags.json @@ -183,6 +183,10 @@ "name": "Rum Metrics", "description": "Manage configuration of [rum-based metrics](https://app.datadoghq.com/rum/generate-metrics) for your organization." }, + "scim": { + "name": "SCIM", + "description": "Provision Datadog teams using SCIM group APIs." + }, "security-monitoring": { "name": "Security Monitoring", "description": "Create and manage your security rules, signals, filters, and more. See the [Datadog Security page](https://docs.datadoghq.com/security/) for more information." diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index 9f1b6d38e2f37..f4b3b9613e3b2 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -56158,6 +56158,299 @@ }, "type": "object" }, + "ExternalUserGroup": { + "description": "Definition of a SCIM group.", + "example": { + "displayName": "Group 1", + "externalId": "group1", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "members": [ + { + "display": "John Doe", + "type": "User", + "value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/0" + }, + { + "display": "Jane Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "properties": { + "displayName": { + "description": "A human-readable name for the group.", + "type": "string" + }, + "externalId": { + "description": "An identifier for the resource as defined by the provisioning client.", + "type": "string" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a group.", + "type": "string" + }, + "members": { + "description": "Members of the SCIM group.", + "items": { + "description": "The definition of a member belonging to a SCIM group.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "A human-readable name for the group member.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource.", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "Input JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ExternalUserGroupMembersItems": { + "description": "The definition of a member belonging to a SCIM group.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "A human-readable name for the group member.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource.", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "ExternalUserGroupMeta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "ExternalUserGroupPatchRequest": { + "description": "Request object for patching a SCIM group.", + "example": { + "Operations": [ + { + "op": "replace", + "path": "None", + "value": { + "displayName": "Real new group", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad" + } + }, + { + "op": "add", + "path": "None", + "value": { + "members": [ + { + "displayName": "Bob Smith", + "value": "f85e3868-ad7b-47e3-a8a9-ff1eade2bbf9", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/patch/requestBody/content/application~1json/schema/example/Operations/1/value/members/0" + } + ] + } + }, + { + "op": "remove", + "path": "members[value eq \"fddf0cf2-9b60-11ef-ad4b-d6754a54a839\"]", + "value": null + } + ], + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ] + }, + "properties": { + "Operations": { + "description": "A list of update operations to be performed on a SCIM group.", + "items": { + "description": "The definition of an individual patch operation in a patch request.", + "properties": { + "op": { + "description": "The operation to be performed.", + "enum": [ + "add", + "replace", + "remove" + ], + "type": "string", + "x-enum-varnames": [ + "ADD", + "REPLACE", + "REMOVE" + ] + }, + "path": { + "description": "An attribute path describing the target of the operation.", + "example": "members", + "type": "string" + }, + "value": { + "description": "JSON element containing the target values required to apply the patch operation.", + "example": "{\n \"displayName\": \"Real new group\",\n \"id\": \"80df3a9b-24f5-4ebf-9ba0-714455453621\"\n}" + } + }, + "type": "object" + }, + "type": "array" + }, + "schemas": { + "description": "Input JSON Schemas", + "example": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ExternalUserGroupPatchRequestOperationsItems": { + "description": "The definition of an individual patch operation in a patch request.", + "properties": { + "op": { + "description": "The operation to be performed.", + "enum": [ + "add", + "replace", + "remove" + ], + "type": "string", + "x-enum-varnames": [ + "ADD", + "REPLACE", + "REMOVE" + ] + }, + "path": { + "description": "An attribute path describing the target of the operation.", + "example": "members", + "type": "string" + }, + "value": { + "description": "JSON element containing the target values required to apply the patch operation.", + "example": "{\n \"displayName\": \"Real new group\",\n \"id\": \"80df3a9b-24f5-4ebf-9ba0-714455453621\"\n}" + } + }, + "type": "object" + }, + "ExternalUserGroupPatchRequestOperationsItemsOp": { + "description": "The operation to be performed.", + "enum": [ + "add", + "replace", + "remove" + ], + "type": "string", + "x-enum-varnames": [ + "ADD", + "REPLACE", + "REMOVE" + ] + }, "FastlyAccounResponseAttributes": { "description": "Attributes object of a Fastly account.", "properties": { @@ -93460,6 +93753,317 @@ }, "type": "object" }, + "ListExternalUserGroupResponse": { + "description": "List SCIM groups response object.", + "example": { + "Resources": [ + { + "displayName": "Group 1", + "externalId": "group1", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "members": [ + { + "display": "John Doe", + "type": "User", + "value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4", + "$ref": "#/paths/~1api~1v2~1scim~1Groups/get/responses/200/content/application~1json/schema/example/Resources/0/members/0" + }, + { + "display": "Jane Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "$ref": "#/paths/~1api~1v2~1scim~1Groups/get/responses/200/content/application~1json/schema/example/Resources/0/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + { + "displayName": "Group 2", + "externalId": "group2", + "id": "79ef0d28-f257-4829-97e6-d23d2a26cb1a", + "members": [ + { + "display": "Alice Smith", + "type": "User", + "value": "29da9fb7-8fca-4e87-bf58-86652253deae", + "$ref": "#/paths/~1api~1v2~1scim~1Groups/get/responses/200/content/application~1json/schema/example/Resources/1/members/0" + }, + { + "display": "Bob Smith", + "type": "User", + "value": "f85e3868-ad7b-47e3-a8a9-ff1eade2bbf9", + "$ref": "#/paths/~1api~1v2~1scim~1Groups/get/responses/200/content/application~1json/schema/example/Resources/1/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055139748Z", + "lastModified": "2024-11-22T15:05:52.055139813Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/79ef0d28-f257-4829-97e6-d23d2a26cb1a", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + } + ], + "itemsPerPage": 2, + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "startIndex": 1, + "totalResults": 2 + }, + "properties": { + "Resources": { + "description": "List of SCIM groups matching the request criteria.", + "items": { + "description": "SCIM resources returned in response to a List SCIM groups request.", + "properties": { + "displayName": { + "description": "A human-readable name for the group.", + "example": "My test group", + "type": "string" + }, + "externalId": { + "description": "An identifier for the resource as defined by the provisioning client.", + "example": "346af543-e5ab-4855-937d-133231cd59ed", + "type": "string" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a group.", + "example": "0e80d350-9519-4771-9aa8-ce849fc36c20", + "type": "string" + }, + "members": { + "description": "A list of members belonging to the team.", + "items": { + "description": "The definition of a member belonging to a group in the List SCIM groups response.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "Full name of the user.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource. Only supported value is \"User\".", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "SCIM group JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "itemsPerPage": { + "description": "Number of SCIM groups returned per page.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + }, + "schemas": { + "description": "List response JSON Schemas.", + "example": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "startIndex": { + "description": "Starting index of the SCIM groups for this page (1-indexed).", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + }, + "totalResults": { + "description": "Total number of SCIM groups matching the request criteria.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "ListExternalUserGroupResponseResourcesItems": { + "description": "SCIM resources returned in response to a List SCIM groups request.", + "properties": { + "displayName": { + "description": "A human-readable name for the group.", + "example": "My test group", + "type": "string" + }, + "externalId": { + "description": "An identifier for the resource as defined by the provisioning client.", + "example": "346af543-e5ab-4855-937d-133231cd59ed", + "type": "string" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a group.", + "example": "0e80d350-9519-4771-9aa8-ce849fc36c20", + "type": "string" + }, + "members": { + "description": "A list of members belonging to the team.", + "items": { + "description": "The definition of a member belonging to a group in the List SCIM groups response.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "Full name of the user.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource. Only supported value is \"User\".", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "SCIM group JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListExternalUserGroupResponseResourcesItemsMembersItems": { + "description": "The definition of a member belonging to a group in the List SCIM groups response.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "Full name of the user.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource. Only supported value is \"User\".", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, "ListFindingsData": { "description": "Array of findings.", "items": { @@ -297925,35 +298529,1536 @@ } } }, - "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": "Not Authorized" + "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": "Not Authorized" + }, + "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": [] + } + ], + "summary": "Search RUM events", + "tags": [ + "RUM" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 1, + "x-pagination": { + "cursorParam": "body.page.cursor", + "cursorPath": "meta.page.after", + "limitParam": "body.page.limit", + "resultsPath": "data" + }, + "x-permission": { + "operator": "OPEN", + "permissions": [] + }, + "x-undo": { + "type": "safe" + } + } + }, + "/api/v2/saml_configurations/idp_metadata": { + "post": { + "description": "Endpoint for uploading IdP metadata for SAML setup.\n\nUse this endpoint to upload or replace IdP metadata for SAML login configuration.", + "operationId": "UploadIdPMetadata", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "description": "The form data submitted to upload IdP metadata", + "properties": { + "idp_file": { + "description": "The IdP metadata XML file", + "format": "binary", + "type": "string", + "x-mimetype": "application/xml" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "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" + } + }, + "summary": "Upload IdP metadata", + "tags": [ + "Organizations" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 1, + "x-permission": { + "operator": "OR", + "permissions": [ + "org_management" + ] + }, + "x-undo": { + "type": "idempotent" + } + } + }, + "/api/v2/scim/Groups": { + "get": { + "description": "List SCIM groups in the organization.\nResults are paginated by `startIndex` and `count` parameters.\nResults can be narrowed down by the `filter` parameter.", + "operationId": "ListSCIMGroups", + "parameters": [ + { + "description": "Specifies the start index to fetch the results (1-indexed).", + "in": "query", + "name": "startIndex", + "required": false, + "schema": { + "default": 1, + "example": 1, + "format": "int64", + "type": "integer" + } + }, + { + "description": "Specifies the number of groups to be returned.", + "in": "query", + "name": "count", + "required": false, + "schema": { + "default": 20, + "example": 20, + "format": "int64", + "type": "integer" + } + }, + { + "description": "Specifies the url encoded filter to use to narrow down the results.\nFilters can be in the form of `displayName eq <group name>` or `externalId eq <external id of group>`\nor `id eq <group id> and members eq <user uuid>` or `members eq <user uuid> and id eq <group id>`.", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "List SCIM groups response object.", + "example": { + "Resources": [ + { + "displayName": "Group 1", + "externalId": "group1", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "members": [ + { + "display": "John Doe", + "type": "User", + "value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4", + "$ref": "#/paths/~1api~1v2~1scim~1Groups/get/responses/200/content/application~1json/schema/example/Resources/0/members/0" + }, + { + "display": "Jane Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "$ref": "#/paths/~1api~1v2~1scim~1Groups/get/responses/200/content/application~1json/schema/example/Resources/0/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + { + "displayName": "Group 2", + "externalId": "group2", + "id": "79ef0d28-f257-4829-97e6-d23d2a26cb1a", + "members": [ + { + "display": "Alice Smith", + "type": "User", + "value": "29da9fb7-8fca-4e87-bf58-86652253deae", + "$ref": "#/paths/~1api~1v2~1scim~1Groups/get/responses/200/content/application~1json/schema/example/Resources/1/members/0" + }, + { + "display": "Bob Smith", + "type": "User", + "value": "f85e3868-ad7b-47e3-a8a9-ff1eade2bbf9", + "$ref": "#/paths/~1api~1v2~1scim~1Groups/get/responses/200/content/application~1json/schema/example/Resources/1/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055139748Z", + "lastModified": "2024-11-22T15:05:52.055139813Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/79ef0d28-f257-4829-97e6-d23d2a26cb1a", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + } + ], + "itemsPerPage": 2, + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "startIndex": 1, + "totalResults": 2 + }, + "properties": { + "Resources": { + "description": "List of SCIM groups matching the request criteria.", + "items": { + "description": "SCIM resources returned in response to a List SCIM groups request.", + "properties": { + "displayName": { + "description": "A human-readable name for the group.", + "example": "My test group", + "type": "string" + }, + "externalId": { + "description": "An identifier for the resource as defined by the provisioning client.", + "example": "346af543-e5ab-4855-937d-133231cd59ed", + "type": "string" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a group.", + "example": "0e80d350-9519-4771-9aa8-ce849fc36c20", + "type": "string" + }, + "members": { + "description": "A list of members belonging to the team.", + "items": { + "description": "The definition of a member belonging to a group in the List SCIM groups response.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "Full name of the user.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource. Only supported value is \"User\".", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "SCIM group JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "itemsPerPage": { + "description": "Number of SCIM groups returned per page.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + }, + "schemas": { + "description": "List response JSON Schemas.", + "example": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "startIndex": { + "description": "Starting index of the SCIM groups for this page (1-indexed).", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + }, + "totalResults": { + "description": "Total number of SCIM groups matching the request criteria.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + } + }, + "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" + }, + "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": [ + { + "AuthZ": [ + "user_access_invite", + "user_access_manage" + ] + } + ], + "summary": "List SCIM groups", + "tags": [ + "SCIM" + ], + "x-menu-order": 1, + "x-permission": { + "operator": "AND", + "permissions": [ + "user_access_invite", + "user_access_manage" + ] + }, + "x-undo": { + "type": "safe" + } + }, + "post": { + "description": "Create a new SCIM group.\nThe group may contain members.", + "operationId": "CreateSCIMGroup", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Definition of a SCIM group.", + "example": { + "displayName": "Group 1", + "externalId": "group1", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "members": [ + { + "display": "John Doe", + "type": "User", + "value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/0" + }, + { + "display": "Jane Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "properties": { + "displayName": { + "description": "A human-readable name for the group.", + "type": "string" + }, + "externalId": { + "description": "An identifier for the resource as defined by the provisioning client.", + "type": "string" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a group.", + "type": "string" + }, + "members": { + "description": "Members of the SCIM group.", + "items": { + "description": "The definition of a member belonging to a SCIM group.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "A human-readable name for the group member.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource.", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "Input JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Definition of a SCIM group.", + "example": { + "displayName": "Group 1", + "externalId": "group1", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "members": [ + { + "display": "John Doe", + "type": "User", + "value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/0" + }, + { + "display": "Jane Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "properties": { + "displayName": { + "description": "A human-readable name for the group.", + "type": "string" + }, + "externalId": { + "description": "An identifier for the resource as defined by the provisioning client.", + "type": "string" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a group.", + "type": "string" + }, + "members": { + "description": "Members of the SCIM group.", + "items": { + "description": "The definition of a member belonging to a SCIM group.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "A human-readable name for the group member.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource.", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "Input JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "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" + }, + "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": [ + { + "AuthZ": [ + "user_access_invite", + "user_access_manage" + ] + } + ], + "summary": "Create SCIM group", + "tags": [ + "SCIM" + ], + "x-menu-order": 2, + "x-permission": { + "operator": "AND", + "permissions": [ + "user_access_invite", + "user_access_manage" + ] + }, + "x-undo": { + "operationId": "DeleteSCIMGroup", + "parameters": [ + { + "name": "group_id", + "source": "<RESPONSE_PATH>" + } + ], + "type": "unsafe" + } + } + }, + "/api/v2/scim/Groups/{group_id}": { + "delete": { + "description": "Delete the SCIM group with the given `group_id`.", + "operationId": "DeleteSCIMGroup", + "parameters": [ + { + "description": "None", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "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" + }, + "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": [ + { + "AuthZ": [ + "user_access_invite", + "user_access_manage" + ] + } + ], + "summary": "Delete SCIM group", + "tags": [ + "SCIM" + ], + "x-menu-order": 5, + "x-permission": { + "operator": "AND", + "permissions": [ + "user_access_invite", + "user_access_manage" + ] + }, + "x-undo": { + "type": "idempotent" + } + }, + "get": { + "description": "Get a single SCIM group using the `group_id`.", + "operationId": "GetSCIMGroup", + "parameters": [ + { + "description": "None", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Definition of a SCIM group.", + "example": { + "displayName": "Group 1", + "externalId": "group1", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "members": [ + { + "display": "John Doe", + "type": "User", + "value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/0" + }, + { + "display": "Jane Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "properties": { + "displayName": { + "description": "A human-readable name for the group.", + "type": "string" + }, + "externalId": { + "description": "An identifier for the resource as defined by the provisioning client.", + "type": "string" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a group.", + "type": "string" + }, + "members": { + "description": "Members of the SCIM group.", + "items": { + "description": "The definition of a member belonging to a SCIM group.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "A human-readable name for the group member.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource.", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "Input JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "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" + }, + "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": [ + { + "AuthZ": [ + "user_access_invite", + "user_access_manage" + ] + } + ], + "summary": "Get SCIM group", + "tags": [ + "SCIM" + ], + "x-menu-order": 3, + "x-permission": { + "operator": "AND", + "permissions": [ + "user_access_invite", + "user_access_manage" + ] + }, + "x-undo": { + "type": "safe" + } + }, + "patch": { + "description": "Patch the SCIM group with the given `group_id`.", + "operationId": "PatchSCIMGroup", + "parameters": [ + { + "description": "None", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request object for patching a SCIM group.", + "example": { + "Operations": [ + { + "op": "replace", + "path": "None", + "value": { + "displayName": "Real new group", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad" + } + }, + { + "op": "add", + "path": "None", + "value": { + "members": [ + { + "displayName": "Bob Smith", + "value": "f85e3868-ad7b-47e3-a8a9-ff1eade2bbf9", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/patch/requestBody/content/application~1json/schema/example/Operations/1/value/members/0" + } + ] + } + }, + { + "op": "remove", + "path": "members[value eq \"fddf0cf2-9b60-11ef-ad4b-d6754a54a839\"]", + "value": null + } + ], + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ] + }, + "properties": { + "Operations": { + "description": "A list of update operations to be performed on a SCIM group.", + "items": { + "description": "The definition of an individual patch operation in a patch request.", + "properties": { + "op": { + "description": "The operation to be performed.", + "enum": [ + "add", + "replace", + "remove" + ], + "type": "string", + "x-enum-varnames": [ + "ADD", + "REPLACE", + "REMOVE" + ] + }, + "path": { + "description": "An attribute path describing the target of the operation.", + "example": "members", + "type": "string" + }, + "value": { + "description": "JSON element containing the target values required to apply the patch operation.", + "example": "{\n \"displayName\": \"Real new group\",\n \"id\": \"80df3a9b-24f5-4ebf-9ba0-714455453621\"\n}" + } + }, + "type": "object" + }, + "type": "array" + }, + "schemas": { + "description": "Input JSON Schemas", + "example": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Definition of a SCIM group.", + "example": { + "displayName": "Group 1", + "externalId": "group1", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "members": [ + { + "display": "John Doe", + "type": "User", + "value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/0" + }, + { + "display": "Jane Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "properties": { + "displayName": { + "description": "A human-readable name for the group.", + "type": "string" + }, + "externalId": { + "description": "An identifier for the resource as defined by the provisioning client.", + "type": "string" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a group.", + "type": "string" + }, + "members": { + "description": "Members of the SCIM group.", + "items": { + "description": "The definition of a member belonging to a SCIM group.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "A human-readable name for the group member.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource.", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "Input JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "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" + }, + "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": { @@ -297986,49 +300091,155 @@ }, "security": [ { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [] + "AuthZ": [ + "user_access_invite", + "user_access_manage" + ] } ], - "summary": "Search RUM events", + "summary": "Patch SCIM group", "tags": [ - "RUM" + "SCIM" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 1, - "x-pagination": { - "cursorParam": "body.page.cursor", - "cursorPath": "meta.page.after", - "limitParam": "body.page.limit", - "resultsPath": "data" - }, + "x-menu-order": 4, "x-permission": { - "operator": "OPEN", - "permissions": [] + "operator": "AND", + "permissions": [ + "user_access_invite", + "user_access_manage" + ] }, "x-undo": { - "type": "safe" + "type": "idempotent" } - } - }, - "/api/v2/saml_configurations/idp_metadata": { - "post": { - "description": "Endpoint for uploading IdP metadata for SAML setup.\n\nUse this endpoint to upload or replace IdP metadata for SAML login configuration.", - "operationId": "UploadIdPMetadata", + }, + "put": { + "description": "Update the SCIM group with the given `group_id`.", + "operationId": "UpdateSCIMGroup", + "parameters": [ + { + "description": "None", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { - "multipart/form-data": { + "application/json": { "schema": { - "description": "The form data submitted to upload IdP metadata", + "description": "Definition of a SCIM group.", + "example": { + "displayName": "Group 1", + "externalId": "group1", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "members": [ + { + "display": "John Doe", + "type": "User", + "value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/0" + }, + { + "display": "Jane Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, "properties": { - "idp_file": { - "description": "The IdP metadata XML file", - "format": "binary", - "type": "string", - "x-mimetype": "application/xml" + "displayName": { + "description": "A human-readable name for the group.", + "type": "string" + }, + "externalId": { + "description": "An identifier for the resource as defined by the provisioning client.", + "type": "string" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a group.", + "type": "string" + }, + "members": { + "description": "Members of the SCIM group.", + "items": { + "description": "The definition of a member belonging to a SCIM group.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "A human-readable name for the group member.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource.", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "Input JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -298039,6 +300250,124 @@ }, "responses": { "200": { + "content": { + "application/json": { + "schema": { + "description": "Definition of a SCIM group.", + "example": { + "displayName": "Group 1", + "externalId": "group1", + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "members": [ + { + "display": "John Doe", + "type": "User", + "value": "d34a5f93-5690-4d3f-a293-f2ad5c7a82a4", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/0" + }, + { + "display": "Jane Doe", + "type": "User", + "value": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "$ref": "#/paths/~1api~1v2~1scim~1Groups~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/example/members/1" + } + ], + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Groups/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "Group" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ] + }, + "properties": { + "displayName": { + "description": "A human-readable name for the group.", + "type": "string" + }, + "externalId": { + "description": "An identifier for the resource as defined by the provisioning client.", + "type": "string" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a group.", + "type": "string" + }, + "members": { + "description": "Members of the SCIM group.", + "items": { + "description": "The definition of a member belonging to a SCIM group.", + "properties": { + "$ref": { + "description": "The URI corresponding to a SCIM resource that is a member of this group.", + "example": "https://app.datadoghq.com/api/scim/v2/Users/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "display": { + "description": "A human-readable name for the group member.", + "example": "John Doe", + "type": "string" + }, + "type": { + "description": "A label indicating the type of resource.", + "example": "User", + "type": "string" + }, + "value": { + "description": "The identifier of the member of this group.", + "example": "429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "description": "Metadata associated with a SCIM group.", + "properties": { + "created": { + "description": "The date and time the group was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the group was last changed.", + "example": "2024-10-19T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "location": { + "description": "URL identifying the resource.", + "example": "https://app.datadoghq.com/api/scim/v2/Groups/429ebce5-8ed3-4da9-9f1e-662f2dbc2fe6", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "Group", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "Input JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, "description": "OK" }, "400": { @@ -298069,7 +300398,7 @@ }, "description": "Bad Request" }, - "403": { + "404": { "content": { "application/json": { "schema": { @@ -298095,7 +300424,35 @@ } } }, - "description": "Forbidden" + "description": "Not Found" + }, + "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": "Conflict" }, "429": { "content": { @@ -298126,16 +300483,24 @@ "description": "Too many requests" } }, - "summary": "Upload IdP metadata", + "security": [ + { + "AuthZ": [ + "user_access_invite", + "user_access_manage" + ] + } + ], + "summary": "Update SCIM group", "tags": [ - "Organizations" + "SCIM" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 1, + "x-menu-order": 6, "x-permission": { - "operator": "OR", + "operator": "AND", "permissions": [ - "org_management" + "user_access_invite", + "user_access_manage" ] }, "x-undo": { @@ -358169,6 +360534,10 @@ }, "name": "Rum Metrics" }, + { + "description": "Provision Datadog teams using SCIM group APIs.", + "name": "SCIM" + }, { "description": "Create and manage your security rules, signals, filters, and more. See the [Datadog Security page](https://docs.datadoghq.com/security/) for more information.", "name": "Security Monitoring"