From fa2267df90259557916878b159cb6f98c6126646 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Wed, 11 Dec 2024 16:00:32 +0000 Subject: [PATCH] Regenerate client from commit 83d14b24 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 | 594 ++++++ data/api/v2/full_spec_deref.json | 2390 ++++++++++++++++++++++- data/api/v2/translate_actions.json | 30 + data/api/v2/translate_tags.json | 4 + static/resources/json/full_spec_v2.json | 2390 ++++++++++++++++++++++- 10 files changed, 5711 insertions(+), 168 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 402591568162c..8688ca63a5f93 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2024-12-11 14:26:40.894706", - "spec_repo_commit": "7a9d0200" + "regenerated": "2024-12-11 16:00:15.254897", + "spec_repo_commit": "83d14b24" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2024-12-11 14:26:49.074421", - "spec_repo_commit": "7a9d0200" + "regenerated": "2024-12-11 16:00:23.092961", + "spec_repo_commit": "83d14b24" } } } \ No newline at end of file diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index fa4d30951cf98..53b94f2005de8 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -7152,6 +7152,82 @@ menu: - ListRumMetrics unstable: [] order: 1 + - name: SCIM + url: /api/latest/scim/ + identifier: scim + generated: true + - name: Update group + url: '#update-group' + identifier: scim-update-group + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - UpdateSCIMGroup + unstable: [] + order: 4 + - name: Patch group + url: '#patch-group' + identifier: scim-patch-group + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - PatchSCIMGroup + unstable: [] + order: 5 + - name: Get group + url: '#get-group' + identifier: scim-get-group + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - GetSCIMGroup + unstable: [] + order: 3 + - name: Delete group + url: '#delete-group' + identifier: scim-delete-group + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - DeleteSCIMGroup + unstable: [] + order: 6 + - name: Create group + url: '#create-group' + identifier: scim-create-group + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - CreateSCIMGroup + unstable: [] + order: 2 + - name: List groups + url: '#list-groups' + identifier: scim-list-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..659e8362b76f1 --- /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": "
\n
\n
\n
\n

Resources

\n
\n

[object]

\n

List of groups matching the request criteria.

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

displayName

\n
\n

string

\n

A human-readable name for the group.

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

externalId

\n
\n

string

\n

An identifier for the resource as defined by the provisioning client.

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

id

\n
\n

string

\n

The identifier of the resource. Not required when creating a group.

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

members

\n
\n

[object]

\n

A list of members belonging to the team.

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

$ref

\n
\n

string

\n

The URI corresponding to a resource that is a member of this group.

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

display

\n
\n

string

\n

Full name of the user.

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

type

\n
\n

string

\n

A label indicating the type of resource. Only supported value is "User".

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

value

\n
\n

string

\n

The identifier of the member of this group.

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

meta

\n
\n

object

\n

Metadata associated with a group.

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

created

\n
\n

date-time

\n

The date and time the group was created.

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

lastModified

\n
\n

date-time

\n

The date and time the group was last changed.

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

location

\n
\n

string

\n

URL identifying the resource.

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

resourceType

\n
\n

string

\n

Type of resource.

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

schemas

\n
\n

[string]

\n

Group JSON Schemas.

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

itemsPerPage

\n
\n

int64

\n

Number of groups returned per page.

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

schemas

\n
\n

[string]

\n

List response JSON Schemas.

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

startIndex

\n
\n

int64

\n

Starting index of the groups for this page (1-indexed).

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

totalResults

\n
\n

int64

\n

Total number of groups matching the request criteria.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "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": "
\n
\n
\n
\n

displayName

\n
\n

string

\n

A human-readable name for the group.

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

externalId

\n
\n

string

\n

An identifier for the resource as defined by the provisioning client.

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

id

\n
\n

string

\n

The identifier of the resource. Not required when creating a group.

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

members

\n
\n

[object]

\n

Members of the group.

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

$ref

\n
\n

string

\n

The URI corresponding to a SCIM resource that is a member of this group.

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

display

\n
\n

string

\n

A human-readable name for the group member.

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

type

\n
\n

string

\n

A label indicating the type of resource.

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

value

\n
\n

string

\n

The identifier of the member of this group.

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

meta

\n
\n

object

\n

Metadata associated with a group.

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

created

\n
\n

date-time

\n

The date and time the group was created.

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

lastModified

\n
\n

date-time

\n

The date and time the group was last changed.

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

location

\n
\n

string

\n

URL identifying the resource.

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

resourceType

\n
\n

string

\n

Type of resource.

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

schemas

\n
\n

[string]

\n

Input JSON Schemas.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": { + "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": "
\n
\n
\n
\n

displayName

\n
\n

string

\n

A human-readable name for the group.

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

externalId

\n
\n

string

\n

An identifier for the resource as defined by the provisioning client.

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

id

\n
\n

string

\n

The identifier of the resource. Not required when creating a group.

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

members

\n
\n

[object]

\n

Members of the group.

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

$ref

\n
\n

string

\n

The URI corresponding to a SCIM resource that is a member of this group.

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

display

\n
\n

string

\n

A human-readable name for the group member.

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

type

\n
\n

string

\n

A label indicating the type of resource.

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

value

\n
\n

string

\n

The identifier of the member of this group.

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

meta

\n
\n

object

\n

Metadata associated with a group.

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

created

\n
\n

date-time

\n

The date and time the group was created.

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

lastModified

\n
\n

date-time

\n

The date and time the group was last changed.

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

location

\n
\n

string

\n

URL identifying the resource.

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

resourceType

\n
\n

string

\n

Type of resource.

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

schemas

\n
\n

[string]

\n

Input JSON Schemas.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "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": "
\n
\n
\n
\n

displayName

\n
\n

string

\n

A human-readable name for the group.

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

externalId

\n
\n

string

\n

An identifier for the resource as defined by the provisioning client.

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

id

\n
\n

string

\n

The identifier of the resource. Not required when creating a group.

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

members

\n
\n

[object]

\n

Members of the group.

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

$ref

\n
\n

string

\n

The URI corresponding to a SCIM resource that is a member of this group.

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

display

\n
\n

string

\n

A human-readable name for the group member.

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

type

\n
\n

string

\n

A label indicating the type of resource.

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

value

\n
\n

string

\n

The identifier of the member of this group.

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

meta

\n
\n

object

\n

Metadata associated with a group.

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

created

\n
\n

date-time

\n

The date and time the group was created.

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

lastModified

\n
\n

date-time

\n

The date and time the group was last changed.

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

location

\n
\n

string

\n

URL identifying the resource.

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

resourceType

\n
\n

string

\n

Type of resource.

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

schemas

\n
\n

[string]

\n

Input JSON Schemas.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "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": "
\n
\n
\n
\n

displayName

\n
\n

string

\n

A human-readable name for the group.

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

externalId

\n
\n

string

\n

An identifier for the resource as defined by the provisioning client.

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

id

\n
\n

string

\n

The identifier of the resource. Not required when creating a group.

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

members

\n
\n

[object]

\n

Members of the group.

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

$ref

\n
\n

string

\n

The URI corresponding to a SCIM resource that is a member of this group.

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

display

\n
\n

string

\n

A human-readable name for the group member.

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

type

\n
\n

string

\n

A label indicating the type of resource.

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

value

\n
\n

string

\n

The identifier of the member of this group.

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

meta

\n
\n

object

\n

Metadata associated with a group.

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

created

\n
\n

date-time

\n

The date and time the group was created.

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

lastModified

\n
\n

date-time

\n

The date and time the group was last changed.

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

location

\n
\n

string

\n

URL identifying the resource.

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

resourceType

\n
\n

string

\n

Type of resource.

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

schemas

\n
\n

[string]

\n

Input JSON Schemas.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": { + "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": "
\n
\n
\n
\n

Operations

\n
\n

[object]

\n

A list of update operations to be performed on a group.

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

op

\n
\n

enum

\n

The operation to be performed. \nAllowed enum values: add,replace,remove

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

path

\n
\n

string

\n

An attribute path describing the target of the operation.

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

value

\n
\n

\n

JSON element containing the target values required to apply the patch operation.

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

schemas

\n
\n

[string]

\n

Input JSON Schemas

\n
\n \n
\n
" + } + }, + "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": "
\n
\n
\n
\n

displayName

\n
\n

string

\n

A human-readable name for the group.

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

externalId

\n
\n

string

\n

An identifier for the resource as defined by the provisioning client.

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

id

\n
\n

string

\n

The identifier of the resource. Not required when creating a group.

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

members

\n
\n

[object]

\n

Members of the group.

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

$ref

\n
\n

string

\n

The URI corresponding to a SCIM resource that is a member of this group.

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

display

\n
\n

string

\n

A human-readable name for the group member.

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

type

\n
\n

string

\n

A label indicating the type of resource.

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

value

\n
\n

string

\n

The identifier of the member of this group.

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

meta

\n
\n

object

\n

Metadata associated with a group.

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

created

\n
\n

date-time

\n

The date and time the group was created.

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

lastModified

\n
\n

date-time

\n

The date and time the group was last changed.

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

location

\n
\n

string

\n

URL identifying the resource.

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

resourceType

\n
\n

string

\n

Type of resource.

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

schemas

\n
\n

[string]

\n

Input JSON Schemas.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "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": "
\n
\n
\n
\n

displayName

\n
\n

string

\n

A human-readable name for the group.

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

externalId

\n
\n

string

\n

An identifier for the resource as defined by the provisioning client.

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

id

\n
\n

string

\n

The identifier of the resource. Not required when creating a group.

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

members

\n
\n

[object]

\n

Members of the group.

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

$ref

\n
\n

string

\n

The URI corresponding to a SCIM resource that is a member of this group.

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

display

\n
\n

string

\n

A human-readable name for the group member.

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

type

\n
\n

string

\n

A label indicating the type of resource.

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

value

\n
\n

string

\n

The identifier of the member of this group.

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

meta

\n
\n

object

\n

Metadata associated with a group.

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

created

\n
\n

date-time

\n

The date and time the group was created.

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

lastModified

\n
\n

date-time

\n

The date and time the group was last changed.

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

location

\n
\n

string

\n

URL identifying the resource.

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

resourceType

\n
\n

string

\n

Type of resource.

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

schemas

\n
\n

[string]

\n

Input JSON Schemas.

\n
\n \n
\n
" + } + } +} \ No newline at end of file diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index b130de62fc85b..d518f531cf561 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -10343,6 +10343,119 @@ components: from the other indexes. type: string type: object + ExternalUserGroup: + description: Definition of a 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 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 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 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 group. + properties: + Operations: + description: A list of update operations to be performed on a 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: @@ -14175,6 +14288,140 @@ components: description: Current link. type: string type: object + ListExternalUserGroupResponse: + description: List 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 groups matching the request criteria. + items: + $ref: '#/components/schemas/ListExternalUserGroupResponseResourcesItems' + type: array + itemsPerPage: + description: Number of 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 groups for this page (1-indexed). + format: int64 + maximum: 4294967295 + minimum: 0 + type: integer + totalResults: + description: Total number of groups matching the request criteria. + format: int64 + maximum: 4294967295 + minimum: 0 + type: integer + type: object + ListExternalUserGroupResponseResourcesItems: + description: Resources returned in response to a List 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: 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 groups + response. + properties: + $ref: + description: The URI corresponding to a 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: @@ -41365,6 +41612,346 @@ paths: - org_management x-undo: type: idempotent + /api/v2/scim/Groups: + get: + description: 'List 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 ` or `externalId + eq ` + + or `id eq and members eq ` or `members eq + and id eq `.' + 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 + - bearerAuth: [] + summary: List 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 group. + + The group may contain members.' + operationId: CreateSCIMGroup + requestBody: + content: + application/json: + examples: + json-request-body: + value: + 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 + 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 + - bearerAuth: [] + summary: Create 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: + type: unsafe + /api/v2/scim/Groups/{group_id}: + delete: + description: Delete the 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 + - bearerAuth: [] + summary: Delete group + tags: + - SCIM + x-menu-order: 6 + x-permission: + operator: AND + permissions: + - user_access_invite + - user_access_manage + x-undo: + type: idempotent + get: + description: Get a single 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 + - bearerAuth: [] + summary: Get 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 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: + examples: + json-request-body: + value: + 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 + 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 + - bearerAuth: [] + summary: Patch group + tags: + - SCIM + x-menu-order: 5 + x-permission: + operator: AND + permissions: + - user_access_invite + - user_access_manage + x-undo: + type: idempotent + put: + description: Update the 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: + examples: + json-request-body: + value: + 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 + 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 + - bearerAuth: [] + summary: Update group + tags: + - SCIM + x-menu-order: 4 + 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. @@ -47861,6 +48448,13 @@ tags: description: Find out more at url: https://docs.datadoghq.com/real_user_monitoring/platform/generate_metrics/ name: Rum Metrics +- description: 'Provision Datadog users and teams using SCIM APIs. + + + Note: SCIM provisioning for Datadog teams is only available for selected organizations + at this point. Request access by contacting Datadog support, or see the [SCIM + page](https://docs.datadoghq.com/account_management/scim/) for more information.' + 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 48649c93e6231..0b2ee6dba6c65 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -58324,6 +58324,238 @@ }, "type": "object" }, + "ExternalUserGroup": { + "description": "Definition of a 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 group.", + "items": { + "description": "The definition of a member belonging to a 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 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 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 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 group.", + "properties": { + "Operations": { + "description": "A list of update operations to be performed on a 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": { @@ -95626,6 +95858,317 @@ }, "type": "object" }, + "ListExternalUserGroupResponse": { + "description": "List 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 groups matching the request criteria.", + "items": { + "description": "Resources returned in response to a List 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 groups response.", + "properties": { + "$ref": { + "description": "The URI corresponding to a 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 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": "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 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 groups for this page (1-indexed).", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + }, + "totalResults": { + "description": "Total number of groups matching the request criteria.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "ListExternalUserGroupResponseResourcesItems": { + "description": "Resources returned in response to a List 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 groups response.", + "properties": { + "$ref": { + "description": "The URI corresponding to a 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 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": "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 groups response.", + "properties": { + "$ref": { + "description": "The URI corresponding to a 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": { @@ -300326,37 +300869,1763 @@ } } }, - "description": "Bad Request" + "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 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 ` or `externalId eq `\nor `id eq and members eq ` or `members eq and id eq `.", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "List 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 groups matching the request criteria.", + "items": { + "description": "Resources returned in response to a List 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 groups response.", + "properties": { + "$ref": { + "description": "The URI corresponding to a 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 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": "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 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 groups for this page (1-indexed).", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + }, + "totalResults": { + "description": "Total number of 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" + ] + }, + { + "bearerAuth": [] + } + ], + "summary": "List 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 group.\nThe group may contain members.", + "operationId": "CreateSCIMGroup", + "requestBody": { + "content": { + "application/json": { + "examples": { + "json-request-body": { + "value": { + "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" + ] + } + } + }, + "schema": { + "description": "Definition of a 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 group.", + "items": { + "description": "The definition of a member belonging to a 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 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 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 group.", + "items": { + "description": "The definition of a member belonging to a 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 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" + ] + }, + { + "bearerAuth": [] + } + ], + "summary": "Create 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": "" + } + ], + "type": "unsafe" + } + } + }, + "/api/v2/scim/Groups/{group_id}": { + "delete": { + "description": "Delete the 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" + ] + }, + { + "bearerAuth": [] + } + ], + "summary": "Delete group", + "tags": [ + "SCIM" + ], + "x-menu-order": 6, + "x-permission": { + "operator": "AND", + "permissions": [ + "user_access_invite", + "user_access_manage" + ] + }, + "x-undo": { + "type": "idempotent" + } + }, + "get": { + "description": "Get a single 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 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 group.", + "items": { + "description": "The definition of a member belonging to a 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 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" + ] + }, + { + "bearerAuth": [] + } + ], + "summary": "Get 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 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": { + "examples": { + "json-request-body": { + "value": { + "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" + ] + } + } + }, + "schema": { + "description": "Request object for patching a group.", + "properties": { + "Operations": { + "description": "A list of update operations to be performed on a 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 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 group.", + "items": { + "description": "The definition of a member belonging to a 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 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" + ] }, - "403": { + { + "bearerAuth": [] + } + ], + "summary": "Patch group", + "tags": [ + "SCIM" + ], + "x-menu-order": 5, + "x-permission": { + "operator": "AND", + "permissions": [ + "user_access_invite", + "user_access_manage" + ] + }, + "x-undo": { + "type": "idempotent" + } + }, + "put": { + "description": "Update the 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": { + "examples": { + "json-request-body": { + "value": { + "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" + ] + } + } + }, + "schema": { + "description": "Definition of a 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 group.", + "items": { + "description": "The definition of a member belonging to a 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 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": { + "200": { "content": { "application/json": { "schema": { - "description": "API error response.", + "description": "Definition of a group.", "properties": { - "errors": { - "description": "A list of errors.", + "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 group.", + "items": { + "description": "The definition of a member belonging to a 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 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": [ - "Bad Request" + "urn:ietf:params:scim:schemas:core:2.0:Group" ], "items": { - "description": "A list of items.", - "example": "Bad Request", "type": "string" }, "type": "array" } }, - "required": [ - "errors" - ], "type": "object" } } }, - "description": "Not Authorized" + "description": "OK" }, - "429": { + "400": { "content": { "application/json": { "schema": { @@ -300382,67 +302651,9 @@ } } }, - "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" + "description": "Bad Request" }, - "400": { + "404": { "content": { "application/json": { "schema": { @@ -300468,9 +302679,9 @@ } } }, - "description": "Bad Request" + "description": "Not Found" }, - "403": { + "409": { "content": { "application/json": { "schema": { @@ -300496,7 +302707,7 @@ } } }, - "description": "Forbidden" + "description": "Conflict" }, "429": { "content": { @@ -300527,16 +302738,27 @@ "description": "Too many requests" } }, - "summary": "Upload IdP metadata", + "security": [ + { + "AuthZ": [ + "user_access_invite", + "user_access_manage" + ] + }, + { + "bearerAuth": [] + } + ], + "summary": "Update group", "tags": [ - "Organizations" + "SCIM" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 1, + "x-menu-order": 4, "x-permission": { - "operator": "OR", + "operator": "AND", "permissions": [ - "org_management" + "user_access_invite", + "user_access_manage" ] }, "x-undo": { @@ -360601,6 +362823,10 @@ }, "name": "Rum Metrics" }, + { + "description": "Provision Datadog users and teams using SCIM APIs.\n\nNote: SCIM provisioning for Datadog teams is only available for selected organizations at this point. Request access by contacting Datadog support, or see the [SCIM page](https://docs.datadoghq.com/account_management/scim/) for more information.", + "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 9f5ccaaaa3ca8..3efb85f4ef9ef 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -1371,6 +1371,36 @@ "request_description": "", "request_schema_description": "The form data submitted to upload IdP metadata" }, + "ListSCIMGroups": { + "description": "List groups in the organization.\nResults are paginated by `startIndex` and `count` parameters.\nResults can be narrowed down by the `filter` parameter.", + "summary": "List groups" + }, + "CreateSCIMGroup": { + "description": "Create a new group.\nThe group may contain members.", + "summary": "Create group", + "request_description": "", + "request_schema_description": "Definition of a group." + }, + "DeleteSCIMGroup": { + "description": "Delete the group with the given `group_id`.", + "summary": "Delete group" + }, + "GetSCIMGroup": { + "description": "Get a single group using the `group_id`.", + "summary": "Get group" + }, + "PatchSCIMGroup": { + "description": "Patch the group with the given `group_id`.", + "summary": "Patch group", + "request_description": "", + "request_schema_description": "Request object for patching a group." + }, + "UpdateSCIMGroup": { + "description": "Update the group with the given `group_id`.", + "summary": "Update group", + "request_description": "", + "request_schema_description": "Definition of a 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..f2719b51289db 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 users and teams using SCIM APIs.\n\nNote: SCIM provisioning for Datadog teams is only available for selected organizations at this point. Request access by contacting Datadog support, or see the [SCIM page](https://docs.datadoghq.com/account_management/scim/) for more information." + }, "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 48649c93e6231..0b2ee6dba6c65 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -58324,6 +58324,238 @@ }, "type": "object" }, + "ExternalUserGroup": { + "description": "Definition of a 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 group.", + "items": { + "description": "The definition of a member belonging to a 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 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 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 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 group.", + "properties": { + "Operations": { + "description": "A list of update operations to be performed on a 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": { @@ -95626,6 +95858,317 @@ }, "type": "object" }, + "ListExternalUserGroupResponse": { + "description": "List 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 groups matching the request criteria.", + "items": { + "description": "Resources returned in response to a List 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 groups response.", + "properties": { + "$ref": { + "description": "The URI corresponding to a 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 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": "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 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 groups for this page (1-indexed).", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + }, + "totalResults": { + "description": "Total number of groups matching the request criteria.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "ListExternalUserGroupResponseResourcesItems": { + "description": "Resources returned in response to a List 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 groups response.", + "properties": { + "$ref": { + "description": "The URI corresponding to a 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 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": "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 groups response.", + "properties": { + "$ref": { + "description": "The URI corresponding to a 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": { @@ -300326,37 +300869,1763 @@ } } }, - "description": "Bad Request" + "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 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 ` or `externalId eq `\nor `id eq and members eq ` or `members eq and id eq `.", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "List 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 groups matching the request criteria.", + "items": { + "description": "Resources returned in response to a List 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 groups response.", + "properties": { + "$ref": { + "description": "The URI corresponding to a 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 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": "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 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 groups for this page (1-indexed).", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + }, + "totalResults": { + "description": "Total number of 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" + ] + }, + { + "bearerAuth": [] + } + ], + "summary": "List 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 group.\nThe group may contain members.", + "operationId": "CreateSCIMGroup", + "requestBody": { + "content": { + "application/json": { + "examples": { + "json-request-body": { + "value": { + "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" + ] + } + } + }, + "schema": { + "description": "Definition of a 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 group.", + "items": { + "description": "The definition of a member belonging to a 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 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 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 group.", + "items": { + "description": "The definition of a member belonging to a 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 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" + ] + }, + { + "bearerAuth": [] + } + ], + "summary": "Create 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": "" + } + ], + "type": "unsafe" + } + } + }, + "/api/v2/scim/Groups/{group_id}": { + "delete": { + "description": "Delete the 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" + ] + }, + { + "bearerAuth": [] + } + ], + "summary": "Delete group", + "tags": [ + "SCIM" + ], + "x-menu-order": 6, + "x-permission": { + "operator": "AND", + "permissions": [ + "user_access_invite", + "user_access_manage" + ] + }, + "x-undo": { + "type": "idempotent" + } + }, + "get": { + "description": "Get a single 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 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 group.", + "items": { + "description": "The definition of a member belonging to a 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 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" + ] + }, + { + "bearerAuth": [] + } + ], + "summary": "Get 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 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": { + "examples": { + "json-request-body": { + "value": { + "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" + ] + } + } + }, + "schema": { + "description": "Request object for patching a group.", + "properties": { + "Operations": { + "description": "A list of update operations to be performed on a 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 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 group.", + "items": { + "description": "The definition of a member belonging to a 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 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" + ] }, - "403": { + { + "bearerAuth": [] + } + ], + "summary": "Patch group", + "tags": [ + "SCIM" + ], + "x-menu-order": 5, + "x-permission": { + "operator": "AND", + "permissions": [ + "user_access_invite", + "user_access_manage" + ] + }, + "x-undo": { + "type": "idempotent" + } + }, + "put": { + "description": "Update the 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": { + "examples": { + "json-request-body": { + "value": { + "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" + ] + } + } + }, + "schema": { + "description": "Definition of a 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 group.", + "items": { + "description": "The definition of a member belonging to a 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 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": { + "200": { "content": { "application/json": { "schema": { - "description": "API error response.", + "description": "Definition of a group.", "properties": { - "errors": { - "description": "A list of errors.", + "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 group.", + "items": { + "description": "The definition of a member belonging to a 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 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": [ - "Bad Request" + "urn:ietf:params:scim:schemas:core:2.0:Group" ], "items": { - "description": "A list of items.", - "example": "Bad Request", "type": "string" }, "type": "array" } }, - "required": [ - "errors" - ], "type": "object" } } }, - "description": "Not Authorized" + "description": "OK" }, - "429": { + "400": { "content": { "application/json": { "schema": { @@ -300382,67 +302651,9 @@ } } }, - "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" + "description": "Bad Request" }, - "400": { + "404": { "content": { "application/json": { "schema": { @@ -300468,9 +302679,9 @@ } } }, - "description": "Bad Request" + "description": "Not Found" }, - "403": { + "409": { "content": { "application/json": { "schema": { @@ -300496,7 +302707,7 @@ } } }, - "description": "Forbidden" + "description": "Conflict" }, "429": { "content": { @@ -300527,16 +302738,27 @@ "description": "Too many requests" } }, - "summary": "Upload IdP metadata", + "security": [ + { + "AuthZ": [ + "user_access_invite", + "user_access_manage" + ] + }, + { + "bearerAuth": [] + } + ], + "summary": "Update group", "tags": [ - "Organizations" + "SCIM" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 1, + "x-menu-order": 4, "x-permission": { - "operator": "OR", + "operator": "AND", "permissions": [ - "org_management" + "user_access_invite", + "user_access_manage" ] }, "x-undo": { @@ -360601,6 +362823,10 @@ }, "name": "Rum Metrics" }, + { + "description": "Provision Datadog users and teams using SCIM APIs.\n\nNote: SCIM provisioning for Datadog teams is only available for selected organizations at this point. Request access by contacting Datadog support, or see the [SCIM page](https://docs.datadoghq.com/account_management/scim/) for more information.", + "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"