diff --git a/.apigentools-info b/.apigentools-info index 6933b5524f593..599d54ce5b1a6 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2024-12-16 19:17:07.158537", - "spec_repo_commit": "162aece5" + "regenerated": "2024-12-16 19:56:37.590688", + "spec_repo_commit": "5670b5a3" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2024-12-16 19:17:14.992857", - "spec_repo_commit": "162aece5" + "regenerated": "2024-12-16 19:56:45.384582", + "spec_repo_commit": "5670b5a3" } } } \ No newline at end of file diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 8c724c8938026..ba2a883673711 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -7183,6 +7183,154 @@ menu: - ListRumMetrics unstable: [] order: 1 + - name: SCIM + url: /api/latest/scim/ + identifier: scim + generated: true + - name: Update user + url: '#update-user' + identifier: scim-update-user + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - UpdateSCIMUser + unstable: [] + order: 4 + - name: Patch user + url: '#patch-user' + identifier: scim-patch-user + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - PatchSCIMUser + unstable: [] + order: 5 + - name: Get user + url: '#get-user' + identifier: scim-get-user + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - GetSCIMUser + unstable: [] + order: 3 + - name: Delete user + url: '#delete-user' + identifier: scim-delete-user + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - DeleteSCIMUser + unstable: [] + order: 6 + - name: Create user + url: '#create-user' + identifier: scim-create-user + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - CreateSCIMUser + unstable: [] + order: 2 + - name: List users + url: '#list-users' + identifier: scim-list-users + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - ListSCIMUsers + unstable: [] + order: 1 + - name: Update group + url: '#update-group' + identifier: scim-update-group + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - UpdateSCIMGroup + unstable: [] + order: 10 + - name: Patch group + url: '#patch-group' + identifier: scim-patch-group + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - PatchSCIMGroup + unstable: [] + order: 11 + - name: Get group + url: '#get-group' + identifier: scim-get-group + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - GetSCIMGroup + unstable: [] + order: 9 + - name: Delete group + url: '#delete-group' + identifier: scim-delete-group + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - DeleteSCIMGroup + unstable: [] + order: 12 + - name: Create group + url: '#create-group' + identifier: scim-create-group + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - CreateSCIMGroup + unstable: [] + order: 8 + - name: List groups + url: '#list-groups' + identifier: scim-list-groups + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - ListSCIMGroups + unstable: [] + order: 7 - 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..da398017fd6ed --- /dev/null +++ b/content/en/api/v2/scim/examples.json @@ -0,0 +1,771 @@ +{ + "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
" + } + }, + "ListSCIMUsers": { + "responses": { + "200": { + "json": { + "Resources": [ + { + "active": false, + "emails": [ + { + "primary": false, + "type": "string", + "value": "string" + } + ], + "id": "string", + "meta": { + "created": "2024-10-17T12:53:35.793Z", + "lastModified": "2024-10-19T12:53:35.793Z", + "location": "https://app.datadoghq.com/api/scim/v2/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "resourceType": "User" + }, + "name": { + "formatted": "string" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "title": "string", + "userName": "string" + } + ], + "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 users matching the request criteria.

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

active

\n
\n

boolean

\n

A Boolean value indicating the User's administrative status.

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

emails

\n
\n

[object]

\n

Email addresses for the user.

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

primary

\n
\n

boolean

\n

Boolean indicating if this email is the primary email address.

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

type

\n
\n

enum

\n

The type of email. \nAllowed enum values: work

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

value

\n
\n

string

\n

Email addresses for the user.

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

id

\n
\n

string

\n

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

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

meta

\n
\n

object

\n

Metadata associated with a user.

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

created

\n
\n

date-time

\n

The date and time the user was created.

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

lastModified

\n
\n

date-time

\n

The date and time the user 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

name

\n
\n

object

\n

The components of user's real name

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

formatted

\n
\n

string

\n

The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.

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

schemas

\n
\n

[string]

\n

User JSON Schemas.

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

title

\n
\n

string

\n

The user's title.

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

userName

\n
\n

string

\n

Unique identifier for the User.

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

itemsPerPage

\n
\n

int64

\n

Number of users 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 users for this page (1-indexed).

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

totalResults

\n
\n

int64

\n

Total number of users 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": "" + } + }, + "CreateSCIMUser": { + "responses": { + "201": { + "json": { + "active": false, + "emails": [ + { + "primary": false, + "type": "string", + "value": "string" + } + ], + "id": "string", + "meta": { + "created": "2024-10-17T12:53:35.793Z", + "lastModified": "2024-10-19T12:53:35.793Z", + "location": "https://app.datadoghq.com/api/scim/v2/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "resourceType": "User" + }, + "name": { + "formatted": "string" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "title": "string", + "userName": "string" + }, + "html": "
\n
\n
\n
\n

active

\n
\n

boolean

\n

A Boolean value indicating the User's administrative status.

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

emails

\n
\n

[object]

\n

Email addresses for the user.

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

primary

\n
\n

boolean

\n

Boolean indicating if this email is the primary email address.

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

type

\n
\n

enum

\n

The type of email. \nAllowed enum values: work

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

value

\n
\n

string

\n

Email addresses for the user.

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

id

\n
\n

string

\n

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

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

meta

\n
\n

object

\n

Metadata associated with a user.

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

created

\n
\n

date-time

\n

The date and time the user was created.

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

lastModified

\n
\n

date-time

\n

The date and time the user 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

name

\n
\n

object

\n

The components of user's real name

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

formatted

\n
\n

string

\n

The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.

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

schemas

\n
\n

[string]

\n

User JSON Schemas.

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

title

\n
\n

string

\n

The user's title.

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

userName

\n
\n

string

\n

Unique identifier for the User.

\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": { + "active": false, + "emails": [ + { + "primary": false, + "type": "string", + "value": "string" + } + ], + "id": "string", + "meta": { + "created": "2024-10-17T12:53:35.793Z", + "lastModified": "2024-10-19T12:53:35.793Z", + "location": "https://app.datadoghq.com/api/scim/v2/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "resourceType": "User" + }, + "name": { + "formatted": "string" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "title": "string", + "userName": "string" + }, + "html": "
\n
\n
\n
\n

active

\n
\n

boolean

\n

A Boolean value indicating the User's administrative status.

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

emails

\n
\n

[object]

\n

Email addresses for the user.

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

primary

\n
\n

boolean

\n

Boolean indicating if this email is the primary email address.

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

type

\n
\n

enum

\n

The type of email. \nAllowed enum values: work

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

value

\n
\n

string

\n

Email addresses for the user.

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

id

\n
\n

string

\n

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

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

meta

\n
\n

object

\n

Metadata associated with a user.

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

created

\n
\n

date-time

\n

The date and time the user was created.

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

lastModified

\n
\n

date-time

\n

The date and time the user 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

name

\n
\n

object

\n

The components of user's real name

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

formatted

\n
\n

string

\n

The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.

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

schemas

\n
\n

[string]

\n

User JSON Schemas.

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

title

\n
\n

string

\n

The user's title.

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

userName

\n
\n

string

\n

Unique identifier for the User.

\n
\n \n
\n
" + } + }, + "DeleteSCIMUser": { + "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": "" + } + }, + "GetSCIMUser": { + "responses": { + "200": { + "json": { + "active": false, + "emails": [ + { + "primary": false, + "type": "string", + "value": "string" + } + ], + "id": "string", + "meta": { + "created": "2024-10-17T12:53:35.793Z", + "lastModified": "2024-10-19T12:53:35.793Z", + "location": "https://app.datadoghq.com/api/scim/v2/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "resourceType": "User" + }, + "name": { + "formatted": "string" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "title": "string", + "userName": "string" + }, + "html": "
\n
\n
\n
\n

active

\n
\n

boolean

\n

A Boolean value indicating the User's administrative status.

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

emails

\n
\n

[object]

\n

Email addresses for the user.

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

primary

\n
\n

boolean

\n

Boolean indicating if this email is the primary email address.

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

type

\n
\n

enum

\n

The type of email. \nAllowed enum values: work

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

value

\n
\n

string

\n

Email addresses for the user.

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

id

\n
\n

string

\n

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

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

meta

\n
\n

object

\n

Metadata associated with a user.

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

created

\n
\n

date-time

\n

The date and time the user was created.

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

lastModified

\n
\n

date-time

\n

The date and time the user 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

name

\n
\n

object

\n

The components of user's real name

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

formatted

\n
\n

string

\n

The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.

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

schemas

\n
\n

[string]

\n

User JSON Schemas.

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

title

\n
\n

string

\n

The user's title.

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

userName

\n
\n

string

\n

Unique identifier for the User.

\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": "" + } + }, + "PatchSCIMUser": { + "responses": { + "200": { + "json": { + "active": false, + "emails": [ + { + "primary": false, + "type": "string", + "value": "string" + } + ], + "id": "string", + "meta": { + "created": "2024-10-17T12:53:35.793Z", + "lastModified": "2024-10-19T12:53:35.793Z", + "location": "https://app.datadoghq.com/api/scim/v2/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "resourceType": "User" + }, + "name": { + "formatted": "string" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "title": "string", + "userName": "string" + }, + "html": "
\n
\n
\n
\n

active

\n
\n

boolean

\n

A Boolean value indicating the User's administrative status.

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

emails

\n
\n

[object]

\n

Email addresses for the user.

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

primary

\n
\n

boolean

\n

Boolean indicating if this email is the primary email address.

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

type

\n
\n

enum

\n

The type of email. \nAllowed enum values: work

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

value

\n
\n

string

\n

Email addresses for the user.

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

id

\n
\n

string

\n

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

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

meta

\n
\n

object

\n

Metadata associated with a user.

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

created

\n
\n

date-time

\n

The date and time the user was created.

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

lastModified

\n
\n

date-time

\n

The date and time the user 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

name

\n
\n

object

\n

The components of user's real name

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

formatted

\n
\n

string

\n

The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.

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

schemas

\n
\n

[string]

\n

User JSON Schemas.

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

title

\n
\n

string

\n

The user's title.

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

userName

\n
\n

string

\n

Unique identifier for the User.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "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": "title", + "value": "undefined" + } + ], + "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 user.

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

op

\n
\n

enum

\n

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

\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

New value to use for 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
" + } + }, + "UpdateSCIMUser": { + "responses": { + "200": { + "json": { + "active": false, + "emails": [ + { + "primary": false, + "type": "string", + "value": "string" + } + ], + "id": "string", + "meta": { + "created": "2024-10-17T12:53:35.793Z", + "lastModified": "2024-10-19T12:53:35.793Z", + "location": "https://app.datadoghq.com/api/scim/v2/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "resourceType": "User" + }, + "name": { + "formatted": "string" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "title": "string", + "userName": "string" + }, + "html": "
\n
\n
\n
\n

active

\n
\n

boolean

\n

A Boolean value indicating the User's administrative status.

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

emails

\n
\n

[object]

\n

Email addresses for the user.

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

primary

\n
\n

boolean

\n

Boolean indicating if this email is the primary email address.

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

type

\n
\n

enum

\n

The type of email. \nAllowed enum values: work

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

value

\n
\n

string

\n

Email addresses for the user.

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

id

\n
\n

string

\n

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

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

meta

\n
\n

object

\n

Metadata associated with a user.

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

created

\n
\n

date-time

\n

The date and time the user was created.

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

lastModified

\n
\n

date-time

\n

The date and time the user 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

name

\n
\n

object

\n

The components of user's real name

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

formatted

\n
\n

string

\n

The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.

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

schemas

\n
\n

[string]

\n

User JSON Schemas.

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

title

\n
\n

string

\n

The user's title.

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

userName

\n
\n

string

\n

Unique identifier for the User.

\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": { + "active": false, + "emails": [ + { + "primary": false, + "type": "string", + "value": "string" + } + ], + "id": "string", + "meta": { + "created": "2024-10-17T12:53:35.793Z", + "lastModified": "2024-10-19T12:53:35.793Z", + "location": "https://app.datadoghq.com/api/scim/v2/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "resourceType": "User" + }, + "name": { + "formatted": "string" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "title": "string", + "userName": "string" + }, + "html": "
\n
\n
\n
\n

active

\n
\n

boolean

\n

A Boolean value indicating the User's administrative status.

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

emails

\n
\n

[object]

\n

Email addresses for the user.

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

primary

\n
\n

boolean

\n

Boolean indicating if this email is the primary email address.

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

type

\n
\n

enum

\n

The type of email. \nAllowed enum values: work

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

value

\n
\n

string

\n

Email addresses for the user.

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

id

\n
\n

string

\n

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

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

meta

\n
\n

object

\n

Metadata associated with a user.

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

created

\n
\n

date-time

\n

The date and time the user was created.

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

lastModified

\n
\n

date-time

\n

The date and time the user 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

name

\n
\n

object

\n

The components of user's real name

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

formatted

\n
\n

string

\n

The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.

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

schemas

\n
\n

[string]

\n

User JSON Schemas.

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

title

\n
\n

string

\n

The user's title.

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

userName

\n
\n

string

\n

Unique identifier for the User.

\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 36602f2421f98..ee71f9b6e1eae 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -9057,6 +9057,13 @@ components: - type - attributes type: object + EmailTypeType: + description: The type of email. + enum: + - work + type: string + x-enum-varnames: + - WORK EntityAttributes: description: Entity attributes. properties: @@ -10507,6 +10514,231 @@ components: from the other indexes. type: string type: object + ExternalUser: + description: Definition of a user. + properties: + active: + description: A Boolean value indicating the User's administrative status. + type: boolean + emails: + description: Email addresses for the user. + items: + $ref: '#/components/schemas/ExternalUserEmailType' + type: array + id: + description: The identifier of the resource. Not required when creating + a user. + type: string + meta: + $ref: '#/components/schemas/ExternalUserMeta' + name: + $ref: '#/components/schemas/ExternalUserNameType' + schemas: + description: User JSON Schemas. + example: + - urn:ietf:params:scim:schemas:core:2.0:User + items: + type: string + type: array + title: + description: The user's title. + type: string + userName: + description: Unique identifier for the User. + type: string + type: object + ExternalUserEmailType: + description: Email address for the user. + properties: + primary: + description: Boolean indicating if this email is the primary email address. + type: boolean + type: + $ref: '#/components/schemas/EmailTypeType' + value: + description: Email addresses for the user. + 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 + ExternalUserMeta: + description: Metadata associated with a user. + properties: + created: + description: The date and time the user was created. + example: 2024-10-17 12:53:35.793883+00:00 + format: date-time + type: string + lastModified: + description: The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c + type: string + resourceType: + description: Type of resource. + example: User + type: string + type: object + ExternalUserNameType: + description: The components of user's real name + properties: + formatted: + description: The full name, including all middle names, titles, and suffixes + as appropriate, formatted for display. + type: string + type: object + ExternalUserPatchRequest: + description: Request object for patching a user. + properties: + Operations: + description: A list of update operations to be performed on a user. + items: + $ref: '#/components/schemas/ExternalUserPatchRequestOperationsItems' + type: array + schemas: + description: Input JSON Schemas + example: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + items: + type: string + type: array + type: object + ExternalUserPatchRequestOperationsItems: + description: The definition of an individual patch operation in a patch request. + properties: + op: + $ref: '#/components/schemas/ExternalUserPatchRequestOperationsItemsOp' + path: + description: An attribute path describing the target of the operation. + example: title + type: string + value: + description: New value to use for the patch operation. + type: object + ExternalUserPatchRequestOperationsItemsOp: + description: The operation to be performed. + enum: + - add + - replace + type: string + x-enum-varnames: + - ADD + - REPLACE FastlyAccounResponseAttributes: description: Attributes object of a Fastly account. properties: @@ -14339,6 +14571,248 @@ 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 + ListExternalUsersResponse: + description: List users response object. + example: + Resources: + - active: true + emails: + - primary: true + type: work + value: john.doe@datadoghq.com + id: e43536e9-33fe-43f8-90b8-d3e39a7dd6ad + meta: + created: '2024-11-22T15:05:52.055138963Z' + lastModified: '2024-11-22T15:05:52.055139017Z' + location: https://app.datadoghq.com/api/scim/v2/Users/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad + resourceType: User + name: + formatted: John Doe + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + title: Mr. + userName: john.doe@datadoghq.com + - active: true + emails: + - primary: true + type: work + value: jane.doe@datadoghq.com + id: 79ef0d28-f257-4829-97e6-d23d2a26cb1a + meta: + created: '2024-11-22T15:05:52.055139748Z' + lastModified: '2024-11-22T15:05:52.055139813Z' + location: https://app.datadoghq.com/api/scim/v2/Users/79ef0d28-f257-4829-97e6-d23d2a26cb1a + resourceType: User + name: + formatted: Jane Doe + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + title: Mrs. + userName: jane.doe@datadoghq.com + itemsPerPage: 2 + schemas: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + startIndex: 1 + totalResults: 2 + properties: + Resources: + description: List of users matching the request criteria. + items: + $ref: '#/components/schemas/ListExternalUsersResponseResourcesItems' + type: array + itemsPerPage: + description: Number of users 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 users for this page (1-indexed). + format: int64 + maximum: 4294967295 + minimum: 0 + type: integer + totalResults: + description: Total number of users matching the request criteria. + format: int64 + maximum: 4294967295 + minimum: 0 + type: integer + type: object + ListExternalUsersResponseResourcesItems: + description: Resources returned in response to a List users request. + properties: + active: + description: A Boolean value indicating the User's administrative status. + type: boolean + emails: + description: Email addresses for the user. + items: + $ref: '#/components/schemas/ExternalUserEmailType' + type: array + id: + description: The identifier of the resource. Not required when creating + a user. + type: string + meta: + $ref: '#/components/schemas/ExternalUserMeta' + name: + $ref: '#/components/schemas/ExternalUserNameType' + schemas: + description: User JSON Schemas. + example: + - urn:ietf:params:scim:schemas:core:2.0:User + items: + type: string + type: array + title: + description: The user's title. + type: string + userName: + description: Unique identifier for the User. + type: string + type: object ListFindingsData: description: Array of findings. items: @@ -41756,6 +42230,644 @@ 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: 7 + 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 + 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 + 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: 8 + 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: 12 + 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: 9 + 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: 11 + 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 + 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: 10 + x-permission: + operator: AND + permissions: + - user_access_invite + - user_access_manage + x-undo: + type: idempotent + /api/v2/scim/Users: + get: + description: 'List users in the organization. + + Results are paginated by `startIndex` and `count` parameters. + + Results can be narrowed down by the `filter` parameter.' + operationId: ListSCIMUsers + 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 users 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. + + Filter should be of the form `userName eq `.' + in: query + name: filter + required: false + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ListExternalUsersResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - AuthZ: + - user_access_invite + - user_access_manage + - bearerAuth: [] + summary: List users + 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 user. + operationId: CreateSCIMUser + requestBody: + content: + application/json: + examples: + json-request-body: + value: + active: true + emails: + - primary: true + type: work + value: john.doe@datadoghq.com + name: + formatted: John Doe + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + title: Mr. + userName: john.doe@datadoghq.com + schema: + $ref: '#/components/schemas/ExternalUser' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalUser' + description: Created + '400': + $ref: '#/components/responses/BadRequestResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - AuthZ: + - user_access_invite + - user_access_manage + - bearerAuth: [] + summary: Create user + tags: + - SCIM + x-menu-order: 2 + x-permission: + operator: AND + permissions: + - user_access_invite + - user_access_manage + x-undo: + operationId: DeleteSCIMUser + parameters: + - name: user_uuid + source: + type: unsafe + /api/v2/scim/Users/{user_uuid}: + delete: + description: Delete the group with the given `user_uuid`. + operationId: DeleteSCIMUser + parameters: + - description: None + in: path + name: user_uuid + 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 user + 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 user using the `user_uuid`. + operationId: GetSCIMUser + parameters: + - description: None + in: path + name: user_uuid + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalUser' + description: OK + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - AuthZ: + - user_access_invite + - user_access_manage + - bearerAuth: [] + summary: Get user + 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 user with the given `user_uuid`. + operationId: PatchSCIMUser + parameters: + - description: None + in: path + name: user_uuid + required: true + schema: + type: string + requestBody: + content: + application/json: + examples: + json-request-body: + value: + Operations: + - op: replace + path: title + value: CEO + - op: replace + value: + name: + formatted: John Doe + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + schema: + $ref: '#/components/schemas/ExternalUserPatchRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalUser' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - AuthZ: + - user_access_invite + - user_access_manage + - bearerAuth: [] + summary: Patch user + 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 user with the given `user_uuid`. + operationId: UpdateSCIMUser + parameters: + - description: None + in: path + name: user_uuid + required: true + schema: + type: string + requestBody: + content: + application/json: + examples: + json-request-body: + value: + active: true + emails: + - primary: true + type: work + value: john.doe@datadoghq.com + id: e43536e9-33fe-43f8-90b8-d3e39a7dd6ad + name: + formatted: John Doe + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + title: Mr. + userName: john.doe@datadoghq.com + schema: + $ref: '#/components/schemas/ExternalUser' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalUser' + 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: Update user + 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. @@ -48261,6 +49373,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 select 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 b9c9336cf9115..4e1c9bb7c0011 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -48156,6 +48156,16 @@ ], "type": "object" }, + "EmailTypeType": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, "EntityAttributes": { "description": "Entity attributes.", "properties": { @@ -58718,6 +58728,482 @@ }, "type": "object" }, + "ExternalUser": { + "description": "Definition of a user.", + "properties": { + "active": { + "description": "A Boolean value indicating the User's administrative status.", + "type": "boolean" + }, + "emails": { + "description": "Email addresses for the user.", + "items": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a user.", + "type": "string" + }, + "meta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "User JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The user's title.", + "type": "string" + }, + "userName": { + "description": "Unique identifier for the User.", + "type": "string" + } + }, + "type": "object" + }, + "ExternalUserEmailType": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "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": { + "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" + ] + }, + "ExternalUserMeta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "ExternalUserNameType": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "ExternalUserPatchRequest": { + "description": "Request object for patching a user.", + "properties": { + "Operations": { + "description": "A list of update operations to be performed on a user.", + "items": { + "description": "The definition of an individual patch operation in a patch request.", + "properties": { + "op": { + "description": "The operation to be performed.", + "enum": [ + "add", + "replace" + ], + "type": "string", + "x-enum-varnames": [ + "ADD", + "REPLACE" + ] + }, + "path": { + "description": "An attribute path describing the target of the operation.", + "example": "title", + "type": "string" + }, + "value": { + "description": "New value to use for the patch operation." + } + }, + "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" + }, + "ExternalUserPatchRequestOperationsItems": { + "description": "The definition of an individual patch operation in a patch request.", + "properties": { + "op": { + "description": "The operation to be performed.", + "enum": [ + "add", + "replace" + ], + "type": "string", + "x-enum-varnames": [ + "ADD", + "REPLACE" + ] + }, + "path": { + "description": "An attribute path describing the target of the operation.", + "example": "title", + "type": "string" + }, + "value": { + "description": "New value to use for the patch operation." + } + }, + "type": "object" + }, + "ExternalUserPatchRequestOperationsItemsOp": { + "description": "The operation to be performed.", + "enum": [ + "add", + "replace" + ], + "type": "string", + "x-enum-varnames": [ + "ADD", + "REPLACE" + ] + }, "FastlyAccounResponseAttributes": { "description": "Attributes object of a Fastly account.", "properties": { @@ -96020,6 +96506,614 @@ }, "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" + }, + "ListExternalUsersResponse": { + "description": "List users response object.", + "example": { + "Resources": [ + { + "active": true, + "emails": [ + { + "primary": true, + "type": "work", + "value": "john.doe@datadoghq.com" + } + ], + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Users/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "User" + }, + "name": { + "formatted": "John Doe" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "title": "Mr.", + "userName": "john.doe@datadoghq.com" + }, + { + "active": true, + "emails": [ + { + "primary": true, + "type": "work", + "value": "jane.doe@datadoghq.com" + } + ], + "id": "79ef0d28-f257-4829-97e6-d23d2a26cb1a", + "meta": { + "created": "2024-11-22T15:05:52.055139748Z", + "lastModified": "2024-11-22T15:05:52.055139813Z", + "location": "https://app.datadoghq.com/api/scim/v2/Users/79ef0d28-f257-4829-97e6-d23d2a26cb1a", + "resourceType": "User" + }, + "name": { + "formatted": "Jane Doe" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "title": "Mrs.", + "userName": "jane.doe@datadoghq.com" + } + ], + "itemsPerPage": 2, + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "startIndex": 1, + "totalResults": 2 + }, + "properties": { + "Resources": { + "description": "List of users matching the request criteria.", + "items": { + "description": "Resources returned in response to a List users request.", + "properties": { + "active": { + "description": "A Boolean value indicating the User's administrative status.", + "type": "boolean" + }, + "emails": { + "description": "Email addresses for the user.", + "items": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a user.", + "type": "string" + }, + "meta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "User JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The user's title.", + "type": "string" + }, + "userName": { + "description": "Unique identifier for the User.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "itemsPerPage": { + "description": "Number of users 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 users for this page (1-indexed).", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + }, + "totalResults": { + "description": "Total number of users matching the request criteria.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "ListExternalUsersResponseResourcesItems": { + "description": "Resources returned in response to a List users request.", + "properties": { + "active": { + "description": "A Boolean value indicating the User's administrative status.", + "type": "boolean" + }, + "emails": { + "description": "Email addresses for the user.", + "items": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a user.", + "type": "string" + }, + "meta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "User JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The user's title.", + "type": "string" + }, + "userName": { + "description": "Unique identifier for the User.", + "type": "string" + } + }, + "type": "object" + }, "ListFindingsData": { "description": "Array of findings.", "items": { @@ -301798,16 +302892,3373 @@ "description": "Too many requests" } }, - "summary": "Upload IdP metadata", + "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": 7, + "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", + "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" + } + ], + "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": 8, + "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": 12, + "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": 9, + "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" + ] + }, + { + "bearerAuth": [] + } + ], + "summary": "Patch group", + "tags": [ + "SCIM" + ], + "x-menu-order": 11, + "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" + } + ], + "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": "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" + }, + "409": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Conflict" + }, + "429": { + "content": { + "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": "Update group", + "tags": [ + "SCIM" + ], + "x-menu-order": 10, + "x-permission": { + "operator": "AND", + "permissions": [ + "user_access_invite", + "user_access_manage" + ] + }, + "x-undo": { + "type": "idempotent" + } + } + }, + "/api/v2/scim/Users": { + "get": { + "description": "List users in the organization.\nResults are paginated by `startIndex` and `count` parameters.\nResults can be narrowed down by the `filter` parameter.", + "operationId": "ListSCIMUsers", + "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 users 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.\nFilter should be of the form `userName eq `.", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "List users response object.", + "example": { + "Resources": [ + { + "active": true, + "emails": [ + { + "primary": true, + "type": "work", + "value": "john.doe@datadoghq.com" + } + ], + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Users/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "User" + }, + "name": { + "formatted": "John Doe" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "title": "Mr.", + "userName": "john.doe@datadoghq.com" + }, + { + "active": true, + "emails": [ + { + "primary": true, + "type": "work", + "value": "jane.doe@datadoghq.com" + } + ], + "id": "79ef0d28-f257-4829-97e6-d23d2a26cb1a", + "meta": { + "created": "2024-11-22T15:05:52.055139748Z", + "lastModified": "2024-11-22T15:05:52.055139813Z", + "location": "https://app.datadoghq.com/api/scim/v2/Users/79ef0d28-f257-4829-97e6-d23d2a26cb1a", + "resourceType": "User" + }, + "name": { + "formatted": "Jane Doe" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "title": "Mrs.", + "userName": "jane.doe@datadoghq.com" + } + ], + "itemsPerPage": 2, + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "startIndex": 1, + "totalResults": 2 + }, + "properties": { + "Resources": { + "description": "List of users matching the request criteria.", + "items": { + "description": "Resources returned in response to a List users request.", + "properties": { + "active": { + "description": "A Boolean value indicating the User's administrative status.", + "type": "boolean" + }, + "emails": { + "description": "Email addresses for the user.", + "items": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a user.", + "type": "string" + }, + "meta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "User JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The user's title.", + "type": "string" + }, + "userName": { + "description": "Unique identifier for the User.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "itemsPerPage": { + "description": "Number of users 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 users for this page (1-indexed).", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + }, + "totalResults": { + "description": "Total number of users 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 users", + "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 user.", + "operationId": "CreateSCIMUser", + "requestBody": { + "content": { + "application/json": { + "examples": { + "json-request-body": { + "value": { + "active": true, + "emails": [ + { + "primary": true, + "type": "work", + "value": "john.doe@datadoghq.com" + } + ], + "name": { + "formatted": "John Doe" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "title": "Mr.", + "userName": "john.doe@datadoghq.com" + } + } + }, + "schema": { + "description": "Definition of a user.", + "properties": { + "active": { + "description": "A Boolean value indicating the User's administrative status.", + "type": "boolean" + }, + "emails": { + "description": "Email addresses for the user.", + "items": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a user.", + "type": "string" + }, + "meta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "User JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The user's title.", + "type": "string" + }, + "userName": { + "description": "Unique identifier for the User.", + "type": "string" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Definition of a user.", + "properties": { + "active": { + "description": "A Boolean value indicating the User's administrative status.", + "type": "boolean" + }, + "emails": { + "description": "Email addresses for the user.", + "items": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a user.", + "type": "string" + }, + "meta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "User JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The user's title.", + "type": "string" + }, + "userName": { + "description": "Unique identifier for the User.", + "type": "string" + } + }, + "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 user", + "tags": [ + "SCIM" + ], + "x-menu-order": 2, + "x-permission": { + "operator": "AND", + "permissions": [ + "user_access_invite", + "user_access_manage" + ] + }, + "x-undo": { + "operationId": "DeleteSCIMUser", + "parameters": [ + { + "name": "user_uuid", + "source": "" + } + ], + "type": "unsafe" + } + } + }, + "/api/v2/scim/Users/{user_uuid}": { + "delete": { + "description": "Delete the group with the given `user_uuid`.", + "operationId": "DeleteSCIMUser", + "parameters": [ + { + "description": "None", + "in": "path", + "name": "user_uuid", + "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 user", + "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 user using the `user_uuid`.", + "operationId": "GetSCIMUser", + "parameters": [ + { + "description": "None", + "in": "path", + "name": "user_uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Definition of a user.", + "properties": { + "active": { + "description": "A Boolean value indicating the User's administrative status.", + "type": "boolean" + }, + "emails": { + "description": "Email addresses for the user.", + "items": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a user.", + "type": "string" + }, + "meta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "User JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The user's title.", + "type": "string" + }, + "userName": { + "description": "Unique identifier for the User.", + "type": "string" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "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 user", + "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 user with the given `user_uuid`.", + "operationId": "PatchSCIMUser", + "parameters": [ + { + "description": "None", + "in": "path", + "name": "user_uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "examples": { + "json-request-body": { + "value": { + "Operations": [ + { + "op": "replace", + "path": "title", + "value": "CEO" + }, + { + "op": "replace", + "value": { + "name": { + "formatted": "John Doe" + } + } + } + ], + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ] + } + } + }, + "schema": { + "description": "Request object for patching a user.", + "properties": { + "Operations": { + "description": "A list of update operations to be performed on a user.", + "items": { + "description": "The definition of an individual patch operation in a patch request.", + "properties": { + "op": { + "description": "The operation to be performed.", + "enum": [ + "add", + "replace" + ], + "type": "string", + "x-enum-varnames": [ + "ADD", + "REPLACE" + ] + }, + "path": { + "description": "An attribute path describing the target of the operation.", + "example": "title", + "type": "string" + }, + "value": { + "description": "New value to use for the patch operation." + } + }, + "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 user.", + "properties": { + "active": { + "description": "A Boolean value indicating the User's administrative status.", + "type": "boolean" + }, + "emails": { + "description": "Email addresses for the user.", + "items": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a user.", + "type": "string" + }, + "meta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "User JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The user's title.", + "type": "string" + }, + "userName": { + "description": "Unique identifier for the User.", + "type": "string" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "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": "Patch user", "tags": [ - "Organizations" + "SCIM" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 1, + "x-menu-order": 5, "x-permission": { - "operator": "OR", + "operator": "AND", "permissions": [ - "org_management" + "user_access_invite", + "user_access_manage" + ] + }, + "x-undo": { + "type": "idempotent" + } + }, + "put": { + "description": "Update the user with the given `user_uuid`.", + "operationId": "UpdateSCIMUser", + "parameters": [ + { + "description": "None", + "in": "path", + "name": "user_uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "examples": { + "json-request-body": { + "value": { + "active": true, + "emails": [ + { + "primary": true, + "type": "work", + "value": "john.doe@datadoghq.com" + } + ], + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "name": { + "formatted": "John Doe" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "title": "Mr.", + "userName": "john.doe@datadoghq.com" + } + } + }, + "schema": { + "description": "Definition of a user.", + "properties": { + "active": { + "description": "A Boolean value indicating the User's administrative status.", + "type": "boolean" + }, + "emails": { + "description": "Email addresses for the user.", + "items": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a user.", + "type": "string" + }, + "meta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "User JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The user's title.", + "type": "string" + }, + "userName": { + "description": "Unique identifier for the User.", + "type": "string" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Definition of a user.", + "properties": { + "active": { + "description": "A Boolean value indicating the User's administrative status.", + "type": "boolean" + }, + "emails": { + "description": "Email addresses for the user.", + "items": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a user.", + "type": "string" + }, + "meta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "User JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The user's title.", + "type": "string" + }, + "userName": { + "description": "Unique identifier for the User.", + "type": "string" + } + }, + "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": "Update user", + "tags": [ + "SCIM" + ], + "x-menu-order": 4, + "x-permission": { + "operator": "AND", + "permissions": [ + "user_access_invite", + "user_access_manage" ] }, "x-undo": { @@ -361878,6 +366329,10 @@ }, "name": "Rum Metrics" }, + { + "description": "Provision Datadog users and teams using SCIM APIs.\n\nNote: SCIM provisioning for Datadog teams is only available for select 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 10cc806fecf93..47de40ecc6e93 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -1379,6 +1379,66 @@ "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." + }, + "ListSCIMUsers": { + "description": "List users in the organization.\nResults are paginated by `startIndex` and `count` parameters.\nResults can be narrowed down by the `filter` parameter.", + "summary": "List users" + }, + "CreateSCIMUser": { + "description": "Create a new user.", + "summary": "Create user", + "request_description": "", + "request_schema_description": "Definition of a user." + }, + "DeleteSCIMUser": { + "description": "Delete the group with the given `user_uuid`.", + "summary": "Delete user" + }, + "GetSCIMUser": { + "description": "Get a single user using the `user_uuid`.", + "summary": "Get user" + }, + "PatchSCIMUser": { + "description": "Patch the user with the given `user_uuid`.", + "summary": "Patch user", + "request_description": "", + "request_schema_description": "Request object for patching a user." + }, + "UpdateSCIMUser": { + "description": "Update the user with the given `user_uuid`.", + "summary": "Update user", + "request_description": "", + "request_schema_description": "Definition of a user." + }, "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 998654dfcd756..b42d709e55667 100644 --- a/data/api/v2/translate_tags.json +++ b/data/api/v2/translate_tags.json @@ -187,6 +187,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 select 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 b9c9336cf9115..4e1c9bb7c0011 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -48156,6 +48156,16 @@ ], "type": "object" }, + "EmailTypeType": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, "EntityAttributes": { "description": "Entity attributes.", "properties": { @@ -58718,6 +58728,482 @@ }, "type": "object" }, + "ExternalUser": { + "description": "Definition of a user.", + "properties": { + "active": { + "description": "A Boolean value indicating the User's administrative status.", + "type": "boolean" + }, + "emails": { + "description": "Email addresses for the user.", + "items": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a user.", + "type": "string" + }, + "meta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "User JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The user's title.", + "type": "string" + }, + "userName": { + "description": "Unique identifier for the User.", + "type": "string" + } + }, + "type": "object" + }, + "ExternalUserEmailType": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "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": { + "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" + ] + }, + "ExternalUserMeta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "ExternalUserNameType": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "ExternalUserPatchRequest": { + "description": "Request object for patching a user.", + "properties": { + "Operations": { + "description": "A list of update operations to be performed on a user.", + "items": { + "description": "The definition of an individual patch operation in a patch request.", + "properties": { + "op": { + "description": "The operation to be performed.", + "enum": [ + "add", + "replace" + ], + "type": "string", + "x-enum-varnames": [ + "ADD", + "REPLACE" + ] + }, + "path": { + "description": "An attribute path describing the target of the operation.", + "example": "title", + "type": "string" + }, + "value": { + "description": "New value to use for the patch operation." + } + }, + "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" + }, + "ExternalUserPatchRequestOperationsItems": { + "description": "The definition of an individual patch operation in a patch request.", + "properties": { + "op": { + "description": "The operation to be performed.", + "enum": [ + "add", + "replace" + ], + "type": "string", + "x-enum-varnames": [ + "ADD", + "REPLACE" + ] + }, + "path": { + "description": "An attribute path describing the target of the operation.", + "example": "title", + "type": "string" + }, + "value": { + "description": "New value to use for the patch operation." + } + }, + "type": "object" + }, + "ExternalUserPatchRequestOperationsItemsOp": { + "description": "The operation to be performed.", + "enum": [ + "add", + "replace" + ], + "type": "string", + "x-enum-varnames": [ + "ADD", + "REPLACE" + ] + }, "FastlyAccounResponseAttributes": { "description": "Attributes object of a Fastly account.", "properties": { @@ -96020,6 +96506,614 @@ }, "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" + }, + "ListExternalUsersResponse": { + "description": "List users response object.", + "example": { + "Resources": [ + { + "active": true, + "emails": [ + { + "primary": true, + "type": "work", + "value": "john.doe@datadoghq.com" + } + ], + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Users/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "User" + }, + "name": { + "formatted": "John Doe" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "title": "Mr.", + "userName": "john.doe@datadoghq.com" + }, + { + "active": true, + "emails": [ + { + "primary": true, + "type": "work", + "value": "jane.doe@datadoghq.com" + } + ], + "id": "79ef0d28-f257-4829-97e6-d23d2a26cb1a", + "meta": { + "created": "2024-11-22T15:05:52.055139748Z", + "lastModified": "2024-11-22T15:05:52.055139813Z", + "location": "https://app.datadoghq.com/api/scim/v2/Users/79ef0d28-f257-4829-97e6-d23d2a26cb1a", + "resourceType": "User" + }, + "name": { + "formatted": "Jane Doe" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "title": "Mrs.", + "userName": "jane.doe@datadoghq.com" + } + ], + "itemsPerPage": 2, + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "startIndex": 1, + "totalResults": 2 + }, + "properties": { + "Resources": { + "description": "List of users matching the request criteria.", + "items": { + "description": "Resources returned in response to a List users request.", + "properties": { + "active": { + "description": "A Boolean value indicating the User's administrative status.", + "type": "boolean" + }, + "emails": { + "description": "Email addresses for the user.", + "items": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a user.", + "type": "string" + }, + "meta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "User JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The user's title.", + "type": "string" + }, + "userName": { + "description": "Unique identifier for the User.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "itemsPerPage": { + "description": "Number of users 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 users for this page (1-indexed).", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + }, + "totalResults": { + "description": "Total number of users matching the request criteria.", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "ListExternalUsersResponseResourcesItems": { + "description": "Resources returned in response to a List users request.", + "properties": { + "active": { + "description": "A Boolean value indicating the User's administrative status.", + "type": "boolean" + }, + "emails": { + "description": "Email addresses for the user.", + "items": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a user.", + "type": "string" + }, + "meta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "User JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The user's title.", + "type": "string" + }, + "userName": { + "description": "Unique identifier for the User.", + "type": "string" + } + }, + "type": "object" + }, "ListFindingsData": { "description": "Array of findings.", "items": { @@ -301798,16 +302892,3373 @@ "description": "Too many requests" } }, - "summary": "Upload IdP metadata", + "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": 7, + "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", + "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" + } + ], + "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": 8, + "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": 12, + "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": 9, + "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" + ] + }, + { + "bearerAuth": [] + } + ], + "summary": "Patch group", + "tags": [ + "SCIM" + ], + "x-menu-order": 11, + "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" + } + ], + "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": "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" + }, + "409": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Conflict" + }, + "429": { + "content": { + "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": "Update group", + "tags": [ + "SCIM" + ], + "x-menu-order": 10, + "x-permission": { + "operator": "AND", + "permissions": [ + "user_access_invite", + "user_access_manage" + ] + }, + "x-undo": { + "type": "idempotent" + } + } + }, + "/api/v2/scim/Users": { + "get": { + "description": "List users in the organization.\nResults are paginated by `startIndex` and `count` parameters.\nResults can be narrowed down by the `filter` parameter.", + "operationId": "ListSCIMUsers", + "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 users 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.\nFilter should be of the form `userName eq `.", + "in": "query", + "name": "filter", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "List users response object.", + "example": { + "Resources": [ + { + "active": true, + "emails": [ + { + "primary": true, + "type": "work", + "value": "john.doe@datadoghq.com" + } + ], + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "meta": { + "created": "2024-11-22T15:05:52.055138963Z", + "lastModified": "2024-11-22T15:05:52.055139017Z", + "location": "https://app.datadoghq.com/api/scim/v2/Users/e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "resourceType": "User" + }, + "name": { + "formatted": "John Doe" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "title": "Mr.", + "userName": "john.doe@datadoghq.com" + }, + { + "active": true, + "emails": [ + { + "primary": true, + "type": "work", + "value": "jane.doe@datadoghq.com" + } + ], + "id": "79ef0d28-f257-4829-97e6-d23d2a26cb1a", + "meta": { + "created": "2024-11-22T15:05:52.055139748Z", + "lastModified": "2024-11-22T15:05:52.055139813Z", + "location": "https://app.datadoghq.com/api/scim/v2/Users/79ef0d28-f257-4829-97e6-d23d2a26cb1a", + "resourceType": "User" + }, + "name": { + "formatted": "Jane Doe" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "title": "Mrs.", + "userName": "jane.doe@datadoghq.com" + } + ], + "itemsPerPage": 2, + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "startIndex": 1, + "totalResults": 2 + }, + "properties": { + "Resources": { + "description": "List of users matching the request criteria.", + "items": { + "description": "Resources returned in response to a List users request.", + "properties": { + "active": { + "description": "A Boolean value indicating the User's administrative status.", + "type": "boolean" + }, + "emails": { + "description": "Email addresses for the user.", + "items": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a user.", + "type": "string" + }, + "meta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "User JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The user's title.", + "type": "string" + }, + "userName": { + "description": "Unique identifier for the User.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "itemsPerPage": { + "description": "Number of users 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 users for this page (1-indexed).", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "type": "integer" + }, + "totalResults": { + "description": "Total number of users 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 users", + "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 user.", + "operationId": "CreateSCIMUser", + "requestBody": { + "content": { + "application/json": { + "examples": { + "json-request-body": { + "value": { + "active": true, + "emails": [ + { + "primary": true, + "type": "work", + "value": "john.doe@datadoghq.com" + } + ], + "name": { + "formatted": "John Doe" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "title": "Mr.", + "userName": "john.doe@datadoghq.com" + } + } + }, + "schema": { + "description": "Definition of a user.", + "properties": { + "active": { + "description": "A Boolean value indicating the User's administrative status.", + "type": "boolean" + }, + "emails": { + "description": "Email addresses for the user.", + "items": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a user.", + "type": "string" + }, + "meta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "User JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The user's title.", + "type": "string" + }, + "userName": { + "description": "Unique identifier for the User.", + "type": "string" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Definition of a user.", + "properties": { + "active": { + "description": "A Boolean value indicating the User's administrative status.", + "type": "boolean" + }, + "emails": { + "description": "Email addresses for the user.", + "items": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a user.", + "type": "string" + }, + "meta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "User JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The user's title.", + "type": "string" + }, + "userName": { + "description": "Unique identifier for the User.", + "type": "string" + } + }, + "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 user", + "tags": [ + "SCIM" + ], + "x-menu-order": 2, + "x-permission": { + "operator": "AND", + "permissions": [ + "user_access_invite", + "user_access_manage" + ] + }, + "x-undo": { + "operationId": "DeleteSCIMUser", + "parameters": [ + { + "name": "user_uuid", + "source": "" + } + ], + "type": "unsafe" + } + } + }, + "/api/v2/scim/Users/{user_uuid}": { + "delete": { + "description": "Delete the group with the given `user_uuid`.", + "operationId": "DeleteSCIMUser", + "parameters": [ + { + "description": "None", + "in": "path", + "name": "user_uuid", + "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 user", + "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 user using the `user_uuid`.", + "operationId": "GetSCIMUser", + "parameters": [ + { + "description": "None", + "in": "path", + "name": "user_uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Definition of a user.", + "properties": { + "active": { + "description": "A Boolean value indicating the User's administrative status.", + "type": "boolean" + }, + "emails": { + "description": "Email addresses for the user.", + "items": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a user.", + "type": "string" + }, + "meta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "User JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The user's title.", + "type": "string" + }, + "userName": { + "description": "Unique identifier for the User.", + "type": "string" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "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 user", + "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 user with the given `user_uuid`.", + "operationId": "PatchSCIMUser", + "parameters": [ + { + "description": "None", + "in": "path", + "name": "user_uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "examples": { + "json-request-body": { + "value": { + "Operations": [ + { + "op": "replace", + "path": "title", + "value": "CEO" + }, + { + "op": "replace", + "value": { + "name": { + "formatted": "John Doe" + } + } + } + ], + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ] + } + } + }, + "schema": { + "description": "Request object for patching a user.", + "properties": { + "Operations": { + "description": "A list of update operations to be performed on a user.", + "items": { + "description": "The definition of an individual patch operation in a patch request.", + "properties": { + "op": { + "description": "The operation to be performed.", + "enum": [ + "add", + "replace" + ], + "type": "string", + "x-enum-varnames": [ + "ADD", + "REPLACE" + ] + }, + "path": { + "description": "An attribute path describing the target of the operation.", + "example": "title", + "type": "string" + }, + "value": { + "description": "New value to use for the patch operation." + } + }, + "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 user.", + "properties": { + "active": { + "description": "A Boolean value indicating the User's administrative status.", + "type": "boolean" + }, + "emails": { + "description": "Email addresses for the user.", + "items": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a user.", + "type": "string" + }, + "meta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "User JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The user's title.", + "type": "string" + }, + "userName": { + "description": "Unique identifier for the User.", + "type": "string" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "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": "Patch user", "tags": [ - "Organizations" + "SCIM" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 1, + "x-menu-order": 5, "x-permission": { - "operator": "OR", + "operator": "AND", "permissions": [ - "org_management" + "user_access_invite", + "user_access_manage" + ] + }, + "x-undo": { + "type": "idempotent" + } + }, + "put": { + "description": "Update the user with the given `user_uuid`.", + "operationId": "UpdateSCIMUser", + "parameters": [ + { + "description": "None", + "in": "path", + "name": "user_uuid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "examples": { + "json-request-body": { + "value": { + "active": true, + "emails": [ + { + "primary": true, + "type": "work", + "value": "john.doe@datadoghq.com" + } + ], + "id": "e43536e9-33fe-43f8-90b8-d3e39a7dd6ad", + "name": { + "formatted": "John Doe" + }, + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "title": "Mr.", + "userName": "john.doe@datadoghq.com" + } + } + }, + "schema": { + "description": "Definition of a user.", + "properties": { + "active": { + "description": "A Boolean value indicating the User's administrative status.", + "type": "boolean" + }, + "emails": { + "description": "Email addresses for the user.", + "items": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a user.", + "type": "string" + }, + "meta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "User JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The user's title.", + "type": "string" + }, + "userName": { + "description": "Unique identifier for the User.", + "type": "string" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Definition of a user.", + "properties": { + "active": { + "description": "A Boolean value indicating the User's administrative status.", + "type": "boolean" + }, + "emails": { + "description": "Email addresses for the user.", + "items": { + "description": "Email address for the user.", + "properties": { + "primary": { + "description": "Boolean indicating if this email is the primary email address.", + "type": "boolean" + }, + "type": { + "description": "The type of email.", + "enum": [ + "work" + ], + "type": "string", + "x-enum-varnames": [ + "WORK" + ] + }, + "value": { + "description": "Email addresses for the user.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "description": "The identifier of the resource. Not required when creating a user.", + "type": "string" + }, + "meta": { + "description": "Metadata associated with a user.", + "properties": { + "created": { + "description": "The date and time the user was created.", + "example": "2024-10-17T12:53:35.793Z", + "format": "date-time", + "type": "string" + }, + "lastModified": { + "description": "The date and time the user 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/Users/13a95654-b76d-478d-8636-157a7e461d7c", + "type": "string" + }, + "resourceType": { + "description": "Type of resource.", + "example": "User", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "The components of user's real name", + "properties": { + "formatted": { + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "type": "string" + } + }, + "type": "object" + }, + "schemas": { + "description": "User JSON Schemas.", + "example": [ + "urn:ietf:params:scim:schemas:core:2.0:User" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The user's title.", + "type": "string" + }, + "userName": { + "description": "Unique identifier for the User.", + "type": "string" + } + }, + "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": "Update user", + "tags": [ + "SCIM" + ], + "x-menu-order": 4, + "x-permission": { + "operator": "AND", + "permissions": [ + "user_access_invite", + "user_access_manage" ] }, "x-undo": { @@ -361878,6 +366329,10 @@ }, "name": "Rum Metrics" }, + { + "description": "Provision Datadog users and teams using SCIM APIs.\n\nNote: SCIM provisioning for Datadog teams is only available for select 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"