From de9283cbbcd62a40d4b71b1d96edf0d43520b64c Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Thu, 11 Jun 2026 21:39:06 +0000 Subject: [PATCH] Regenerate client from commit 288e5a6 of spec repo --- config/_default/menus/api.en.yaml | 204 ++ .../api/latest/identity-providers/_index.md | 3 + .../list-identity-providers/index.md | 3 + .../index.md | 3 + .../update-an-identity-provider/index.md | 3 + .../latest/org-authorized-clients/_index.md | 3 + .../index.md | 3 + .../index.md | 3 + .../delete-an-org-authorized-client/index.md | 3 + .../get-an-org-authorized-client/index.md | 3 + .../list-org-authorized-clients/index.md | 3 + .../index.md | 3 + .../update-an-org-authorized-client/index.md | 3 + .../latest/user-authorized-clients/_index.md | 3 + .../delete-a-user-authorized-client/index.md | 3 + .../index.md | 3 + .../get-a-user-authorized-client/index.md | 3 + .../list-user-authorized-clients/index.md | 3 + .../index.md | 3 + .../index.md | 3 + .../en/api/v2/identity-providers/_index.md | 4 + .../api/v2/identity-providers/examples.json | 304 +++ .../api/v2/org-authorized-clients/_index.md | 4 + .../v2/org-authorized-clients/examples.json | 557 +++++ .../api/v2/user-authorized-clients/_index.md | 4 + .../v2/user-authorized-clients/examples.json | 280 +++ content/en/api/v2/users/examples.json | 102 + data/api/v2/full_spec.yaml | 1803 ++++++++++++++++- data/api/v2/translate_actions.json | 70 + data/api/v2/translate_tags.json | 12 + 30 files changed, 3318 insertions(+), 83 deletions(-) create mode 100644 content/en/api/latest/identity-providers/_index.md create mode 100644 content/en/api/latest/identity-providers/list-identity-providers/index.md create mode 100644 content/en/api/latest/identity-providers/list-users-with-an-identity-provider-override/index.md create mode 100644 content/en/api/latest/identity-providers/update-an-identity-provider/index.md create mode 100644 content/en/api/latest/org-authorized-clients/_index.md create mode 100644 content/en/api/latest/org-authorized-clients/delete-a-user-authorization-for-a-client/index.md create mode 100644 content/en/api/latest/org-authorized-clients/delete-a-users-authorizations-for-a-client/index.md create mode 100644 content/en/api/latest/org-authorized-clients/delete-an-org-authorized-client/index.md create mode 100644 content/en/api/latest/org-authorized-clients/get-an-org-authorized-client/index.md create mode 100644 content/en/api/latest/org-authorized-clients/list-org-authorized-clients/index.md create mode 100644 content/en/api/latest/org-authorized-clients/list-user-authorizations-for-a-client/index.md create mode 100644 content/en/api/latest/org-authorized-clients/update-an-org-authorized-client/index.md create mode 100644 content/en/api/latest/user-authorized-clients/_index.md create mode 100644 content/en/api/latest/user-authorized-clients/delete-a-user-authorized-client/index.md create mode 100644 content/en/api/latest/user-authorized-clients/delete-all-user-authorized-clients-for-a-client/index.md create mode 100644 content/en/api/latest/user-authorized-clients/get-a-user-authorized-client/index.md create mode 100644 content/en/api/latest/user-authorized-clients/list-user-authorized-clients/index.md create mode 100644 content/en/api/latest/users/get-identity-provider-overrides-for-a-user/index.md create mode 100644 content/en/api/latest/users/update-identity-provider-overrides-for-a-user/index.md create mode 100644 content/en/api/v2/identity-providers/_index.md create mode 100644 content/en/api/v2/identity-providers/examples.json create mode 100644 content/en/api/v2/org-authorized-clients/_index.md create mode 100644 content/en/api/v2/org-authorized-clients/examples.json create mode 100644 content/en/api/v2/user-authorized-clients/_index.md create mode 100644 content/en/api/v2/user-authorized-clients/examples.json diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index e82539aafdf..7566630b9ec 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -6347,6 +6347,18 @@ menu: url: /api/latest/users/ identifier: users generated: true + - name: Update identity provider overrides for a user + url: /api/latest/users/update-identity-provider-overrides-for-a-user/ + identifier: users-update-identity-provider-overrides-for-a-user + parent: users + generated: true + params: + versions: + - v2 + operationids: + - UpdateUserIdentityProviders + unstable: [] + order: 15 - name: Get a user permissions url: /api/latest/users/get-a-user-permissions/ identifier: users-get-a-user-permissions @@ -6383,6 +6395,18 @@ menu: - DeleteUserInvitations unstable: [] order: 11 + - name: Get identity provider overrides for a user + url: /api/latest/users/get-identity-provider-overrides-for-a-user/ + identifier: users-get-identity-provider-overrides-for-a-user + parent: users + generated: true + params: + versions: + - v2 + operationids: + - GetUserIdentityProviders + unstable: [] + order: 14 - name: Get a user invitation url: /api/latest/users/get-a-user-invitation/ identifier: users-get-a-user-invitation @@ -12108,6 +12132,46 @@ menu: - GetIPAllowlist unstable: [] order: 1 + - name: Identity Providers + url: /api/latest/identity-providers/ + identifier: identity-providers + generated: true + - name: List users with an identity provider override + url: /api/latest/identity-providers/list-users-with-an-identity-provider-override/ + identifier: identity-providers-list-users-with-an-identity-provider-override + parent: identity-providers + generated: true + params: + versions: + - v2 + operationids: + - ListIdentityProviderUsers + unstable: [] + order: 1 + - name: Update an identity provider + url: /api/latest/identity-providers/update-an-identity-provider/ + identifier: identity-providers-update-an-identity-provider + parent: identity-providers + generated: true + params: + versions: + - v2 + operationids: + - UpdateIdentityProvider + unstable: [] + order: 2 + - name: List identity providers + url: /api/latest/identity-providers/list-identity-providers/ + identifier: identity-providers-list-identity-providers + parent: identity-providers + generated: true + params: + versions: + - v2 + operationids: + - ListIdentityProviders + unstable: [] + order: 3 - name: Incident Services url: /api/latest/incident-services/ identifier: incident-services @@ -15269,6 +15333,94 @@ menu: - ListOpsgenieAccounts unstable: [] order: 6 + - name: Org Authorized Clients + url: /api/latest/org-authorized-clients/ + identifier: org-authorized-clients + generated: true + - name: Delete a user authorization for a client + url: /api/latest/org-authorized-clients/delete-a-user-authorization-for-a-client/ + identifier: org-authorized-clients-delete-a-user-authorization-for-a-client + parent: org-authorized-clients + generated: true + params: + versions: + - v2 + operationids: + - DeleteOrgAuthorizedClientUserAuthorization + unstable: [] + order: 2 + - name: List user authorizations for a client + url: /api/latest/org-authorized-clients/list-user-authorizations-for-a-client/ + identifier: org-authorized-clients-list-user-authorizations-for-a-client + parent: org-authorized-clients + generated: true + params: + versions: + - v2 + operationids: + - ListOrgAuthorizedClientUserAuthorizations + unstable: [] + order: 3 + - name: Delete a user's authorizations for a client + url: /api/latest/org-authorized-clients/delete-a-users-authorizations-for-a-client/ + identifier: org-authorized-clients-delete-a-users-authorizations-for-a-client + parent: org-authorized-clients + generated: true + params: + versions: + - v2 + operationids: + - DeleteOrgAuthorizedClientAllUserAuthorizations + unstable: [] + order: 1 + - name: Update an org authorized client + url: /api/latest/org-authorized-clients/update-an-org-authorized-client/ + identifier: org-authorized-clients-update-an-org-authorized-client + parent: org-authorized-clients + generated: true + params: + versions: + - v2 + operationids: + - UpdateOrgAuthorizedClient + unstable: [] + order: 5 + - name: Get an org authorized client + url: /api/latest/org-authorized-clients/get-an-org-authorized-client/ + identifier: org-authorized-clients-get-an-org-authorized-client + parent: org-authorized-clients + generated: true + params: + versions: + - v2 + operationids: + - GetOrgAuthorizedClient + unstable: [] + order: 6 + - name: Delete an org authorized client + url: /api/latest/org-authorized-clients/delete-an-org-authorized-client/ + identifier: org-authorized-clients-delete-an-org-authorized-client + parent: org-authorized-clients + generated: true + params: + versions: + - v2 + operationids: + - DeleteOrgAuthorizedClient + unstable: [] + order: 4 + - name: List org authorized clients + url: /api/latest/org-authorized-clients/list-org-authorized-clients/ + identifier: org-authorized-clients-list-org-authorized-clients + parent: org-authorized-clients + generated: true + params: + versions: + - v2 + operationids: + - ListOrgAuthorizedClients + unstable: [] + order: 7 - name: Org Connections url: /api/latest/org-connections/ identifier: org-connections @@ -19408,6 +19560,58 @@ menu: - UpdateFlakyTestsManagementPolicies unstable: [] order: 7 + - name: User Authorized Clients + url: /api/latest/user-authorized-clients/ + identifier: user-authorized-clients + generated: true + - name: Get a user authorized client + url: /api/latest/user-authorized-clients/get-a-user-authorized-client/ + identifier: user-authorized-clients-get-a-user-authorized-client + parent: user-authorized-clients + generated: true + params: + versions: + - v2 + operationids: + - GetUserAuthorizedClient + unstable: [] + order: 3 + - name: Delete a user authorized client + url: /api/latest/user-authorized-clients/delete-a-user-authorized-client/ + identifier: user-authorized-clients-delete-a-user-authorized-client + parent: user-authorized-clients + generated: true + params: + versions: + - v2 + operationids: + - DeleteUserAuthorizedClient + unstable: [] + order: 2 + - name: Delete all user authorized clients for a client + url: /api/latest/user-authorized-clients/delete-all-user-authorized-clients-for-a-client/ + identifier: user-authorized-clients-delete-all-user-authorized-clients-for-a-client + parent: user-authorized-clients + generated: true + params: + versions: + - v2 + operationids: + - DeleteUserAuthorizedClientsByClient + unstable: [] + order: 1 + - name: List user authorized clients + url: /api/latest/user-authorized-clients/list-user-authorized-clients/ + identifier: user-authorized-clients-list-user-authorized-clients + parent: user-authorized-clients + generated: true + params: + versions: + - v2 + operationids: + - ListUserAuthorizedClients + unstable: [] + order: 4 - name: Widgets url: /api/latest/widgets/ identifier: widgets diff --git a/content/en/api/latest/identity-providers/_index.md b/content/en/api/latest/identity-providers/_index.md new file mode 100644 index 00000000000..cc660056ba2 --- /dev/null +++ b/content/en/api/latest/identity-providers/_index.md @@ -0,0 +1,3 @@ +--- +title: Identity Providers +--- diff --git a/content/en/api/latest/identity-providers/list-identity-providers/index.md b/content/en/api/latest/identity-providers/list-identity-providers/index.md new file mode 100644 index 00000000000..0dafa16fda8 --- /dev/null +++ b/content/en/api/latest/identity-providers/list-identity-providers/index.md @@ -0,0 +1,3 @@ +--- +title: List identity providers +--- diff --git a/content/en/api/latest/identity-providers/list-users-with-an-identity-provider-override/index.md b/content/en/api/latest/identity-providers/list-users-with-an-identity-provider-override/index.md new file mode 100644 index 00000000000..e29037ef5eb --- /dev/null +++ b/content/en/api/latest/identity-providers/list-users-with-an-identity-provider-override/index.md @@ -0,0 +1,3 @@ +--- +title: List users with an identity provider override +--- diff --git a/content/en/api/latest/identity-providers/update-an-identity-provider/index.md b/content/en/api/latest/identity-providers/update-an-identity-provider/index.md new file mode 100644 index 00000000000..38b48a1ad48 --- /dev/null +++ b/content/en/api/latest/identity-providers/update-an-identity-provider/index.md @@ -0,0 +1,3 @@ +--- +title: Update an identity provider +--- diff --git a/content/en/api/latest/org-authorized-clients/_index.md b/content/en/api/latest/org-authorized-clients/_index.md new file mode 100644 index 00000000000..b47d9bd6d48 --- /dev/null +++ b/content/en/api/latest/org-authorized-clients/_index.md @@ -0,0 +1,3 @@ +--- +title: Org Authorized Clients +--- diff --git a/content/en/api/latest/org-authorized-clients/delete-a-user-authorization-for-a-client/index.md b/content/en/api/latest/org-authorized-clients/delete-a-user-authorization-for-a-client/index.md new file mode 100644 index 00000000000..52a136aad5f --- /dev/null +++ b/content/en/api/latest/org-authorized-clients/delete-a-user-authorization-for-a-client/index.md @@ -0,0 +1,3 @@ +--- +title: Delete a user authorization for a client +--- diff --git a/content/en/api/latest/org-authorized-clients/delete-a-users-authorizations-for-a-client/index.md b/content/en/api/latest/org-authorized-clients/delete-a-users-authorizations-for-a-client/index.md new file mode 100644 index 00000000000..d8e767cbcf0 --- /dev/null +++ b/content/en/api/latest/org-authorized-clients/delete-a-users-authorizations-for-a-client/index.md @@ -0,0 +1,3 @@ +--- +title: Delete a user's authorizations for a client +--- diff --git a/content/en/api/latest/org-authorized-clients/delete-an-org-authorized-client/index.md b/content/en/api/latest/org-authorized-clients/delete-an-org-authorized-client/index.md new file mode 100644 index 00000000000..c7f09b9602b --- /dev/null +++ b/content/en/api/latest/org-authorized-clients/delete-an-org-authorized-client/index.md @@ -0,0 +1,3 @@ +--- +title: Delete an org authorized client +--- diff --git a/content/en/api/latest/org-authorized-clients/get-an-org-authorized-client/index.md b/content/en/api/latest/org-authorized-clients/get-an-org-authorized-client/index.md new file mode 100644 index 00000000000..8b8f6a2beb5 --- /dev/null +++ b/content/en/api/latest/org-authorized-clients/get-an-org-authorized-client/index.md @@ -0,0 +1,3 @@ +--- +title: Get an org authorized client +--- diff --git a/content/en/api/latest/org-authorized-clients/list-org-authorized-clients/index.md b/content/en/api/latest/org-authorized-clients/list-org-authorized-clients/index.md new file mode 100644 index 00000000000..32131529be8 --- /dev/null +++ b/content/en/api/latest/org-authorized-clients/list-org-authorized-clients/index.md @@ -0,0 +1,3 @@ +--- +title: List org authorized clients +--- diff --git a/content/en/api/latest/org-authorized-clients/list-user-authorizations-for-a-client/index.md b/content/en/api/latest/org-authorized-clients/list-user-authorizations-for-a-client/index.md new file mode 100644 index 00000000000..23c3cff96ff --- /dev/null +++ b/content/en/api/latest/org-authorized-clients/list-user-authorizations-for-a-client/index.md @@ -0,0 +1,3 @@ +--- +title: List user authorizations for a client +--- diff --git a/content/en/api/latest/org-authorized-clients/update-an-org-authorized-client/index.md b/content/en/api/latest/org-authorized-clients/update-an-org-authorized-client/index.md new file mode 100644 index 00000000000..a6c9800f109 --- /dev/null +++ b/content/en/api/latest/org-authorized-clients/update-an-org-authorized-client/index.md @@ -0,0 +1,3 @@ +--- +title: Update an org authorized client +--- diff --git a/content/en/api/latest/user-authorized-clients/_index.md b/content/en/api/latest/user-authorized-clients/_index.md new file mode 100644 index 00000000000..953b24f6b9e --- /dev/null +++ b/content/en/api/latest/user-authorized-clients/_index.md @@ -0,0 +1,3 @@ +--- +title: User Authorized Clients +--- diff --git a/content/en/api/latest/user-authorized-clients/delete-a-user-authorized-client/index.md b/content/en/api/latest/user-authorized-clients/delete-a-user-authorized-client/index.md new file mode 100644 index 00000000000..59bacbcb621 --- /dev/null +++ b/content/en/api/latest/user-authorized-clients/delete-a-user-authorized-client/index.md @@ -0,0 +1,3 @@ +--- +title: Delete a user authorized client +--- diff --git a/content/en/api/latest/user-authorized-clients/delete-all-user-authorized-clients-for-a-client/index.md b/content/en/api/latest/user-authorized-clients/delete-all-user-authorized-clients-for-a-client/index.md new file mode 100644 index 00000000000..8d922e5a5ad --- /dev/null +++ b/content/en/api/latest/user-authorized-clients/delete-all-user-authorized-clients-for-a-client/index.md @@ -0,0 +1,3 @@ +--- +title: Delete all user authorized clients for a client +--- diff --git a/content/en/api/latest/user-authorized-clients/get-a-user-authorized-client/index.md b/content/en/api/latest/user-authorized-clients/get-a-user-authorized-client/index.md new file mode 100644 index 00000000000..5b4abc939e6 --- /dev/null +++ b/content/en/api/latest/user-authorized-clients/get-a-user-authorized-client/index.md @@ -0,0 +1,3 @@ +--- +title: Get a user authorized client +--- diff --git a/content/en/api/latest/user-authorized-clients/list-user-authorized-clients/index.md b/content/en/api/latest/user-authorized-clients/list-user-authorized-clients/index.md new file mode 100644 index 00000000000..6f4068258f9 --- /dev/null +++ b/content/en/api/latest/user-authorized-clients/list-user-authorized-clients/index.md @@ -0,0 +1,3 @@ +--- +title: List user authorized clients +--- diff --git a/content/en/api/latest/users/get-identity-provider-overrides-for-a-user/index.md b/content/en/api/latest/users/get-identity-provider-overrides-for-a-user/index.md new file mode 100644 index 00000000000..c68a16c728b --- /dev/null +++ b/content/en/api/latest/users/get-identity-provider-overrides-for-a-user/index.md @@ -0,0 +1,3 @@ +--- +title: Get identity provider overrides for a user +--- diff --git a/content/en/api/latest/users/update-identity-provider-overrides-for-a-user/index.md b/content/en/api/latest/users/update-identity-provider-overrides-for-a-user/index.md new file mode 100644 index 00000000000..14e2b28af5b --- /dev/null +++ b/content/en/api/latest/users/update-identity-provider-overrides-for-a-user/index.md @@ -0,0 +1,3 @@ +--- +title: Update identity provider overrides for a user +--- diff --git a/content/en/api/v2/identity-providers/_index.md b/content/en/api/v2/identity-providers/_index.md new file mode 100644 index 00000000000..ee06b5cd1d1 --- /dev/null +++ b/content/en/api/v2/identity-providers/_index.md @@ -0,0 +1,4 @@ +--- +title: Identity Providers +headless: true +--- diff --git a/content/en/api/v2/identity-providers/examples.json b/content/en/api/v2/identity-providers/examples.json new file mode 100644 index 00000000000..ce93c5bd9a7 --- /dev/null +++ b/content/en/api/v2/identity-providers/examples.json @@ -0,0 +1,304 @@ +{ + "ListIdentityProviders": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "authentication_method": "SAML", + "enabled": true + }, + "id": "00000000-0000-0000-0000-000000000001", + "type": "identity_providers" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of organization identity provider data objects.

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

attributes [required]

\n
\n

object

\n

Attributes of an organization identity provider.

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

authentication_method [required]

\n
\n

string

\n

The authentication method used by this identity provider.

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

enabled [required]

\n
\n

boolean

\n

Whether this identity provider is enabled for the organization.

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

id [required]

\n
\n

string

\n

The unique identifier of the identity provider.

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

type [required]

\n
\n

enum

\n

The resource type for identity providers. \nAllowed enum values: identity_providers

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \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": "" + } + }, + "UpdateIdentityProvider": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "authentication_method": "SAML", + "enabled": true + }, + "id": "00000000-0000-0000-0000-000000000001", + "type": "identity_providers" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object representing an organization identity provider.

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

attributes [required]

\n
\n

object

\n

Attributes of an organization identity provider.

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

authentication_method [required]

\n
\n

string

\n

The authentication method used by this identity provider.

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

enabled [required]

\n
\n

boolean

\n

Whether this identity provider is enabled for the organization.

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

id [required]

\n
\n

string

\n

The unique identifier of the identity provider.

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

type [required]

\n
\n

enum

\n

The resource type for identity providers. \nAllowed enum values: identity_providers

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "enabled": true + }, + "id": "00000000-0000-0000-0000-000000000001", + "type": "identity_providers" + } + }, + "json": { + "data": { + "attributes": { + "enabled": true + }, + "id": "00000000-0000-0000-0000-000000000001", + "type": "identity_providers" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for updating an organization identity provider.

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

attributes [required]

\n
\n

object

\n

Attributes for updating an organization identity provider.

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

enabled [required]

\n
\n

boolean

\n

Whether to enable or disable this identity provider for the organization.

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

id [required]

\n
\n

string

\n

The unique identifier of the identity provider to update.

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

type [required]

\n
\n

enum

\n

The resource type for identity providers. \nAllowed enum values: identity_providers

\n
\n \n
\n
\n
\n
" + } + }, + "ListIdentityProviderUsers": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "created_at": "2019-09-19T10:00:00.000Z", + "disabled": false, + "email": "string", + "handle": "string", + "icon": "string", + "last_login_time": "2019-09-19T10:00:00.000Z", + "mfa_enabled": false, + "modified_at": "2019-09-19T10:00:00.000Z", + "name": "string", + "service_account": false, + "status": "string", + "title": "string", + "uuid": "string", + "verified": false + }, + "id": "string", + "relationships": { + "org": { + "data": { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + }, + "other_orgs": { + "data": [ + { + "id": "00000000-0000-beef-0000-000000000000", + "type": "orgs" + } + ] + }, + "other_users": { + "data": [ + { + "id": "00000000-0000-0000-2345-000000000000", + "type": "users" + } + ] + }, + "roles": { + "data": [ + { + "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "roles" + } + ] + } + }, + "type": "users" + } + ], + "included": [ + { + "attributes": { + "created_at": "2019-09-19T10:00:00.000Z", + "description": "string", + "disabled": false, + "modified_at": "2019-09-19T10:00:00.000Z", + "name": "string", + "public_id": "string", + "sharing": "string", + "url": "string" + }, + "id": "string", + "type": "orgs" + } + ], + "meta": { + "page": { + "total_count": "integer", + "total_filtered_count": "integer" + } + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of returned users.

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

attributes

\n
\n

object

\n

Attributes of user object returned by the API.

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

created_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was created.

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

disabled

\n
\n

boolean

\n

Whether the user account is deactivated. Disabled users cannot log in.

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

email

\n
\n

string

\n

The email address of the user, used for login and notifications.

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

handle

\n
\n

string

\n

The unique handle (username) of the user, typically matching their email prefix.

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

icon

\n
\n

string

\n

URL of the user's profile icon, typically a Gravatar URL derived from the email address.

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

last_login_time

\n
\n

date-time

\n

The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.

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

mfa_enabled

\n
\n

boolean

\n

Whether multi-factor authentication (MFA) is enabled for the user's account.

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

modified_at

\n
\n

date-time

\n

The ISO 8601 timestamp of when the user account was last modified.

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

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.

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

service_account

\n
\n

boolean

\n

Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.

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

status

\n
\n

string

\n

The current status of the user account (for example, Active, Pending, or Disabled).

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

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

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

uuid

\n
\n

string

\n

The globally unique identifier (UUID) of the user.

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

verified

\n
\n

boolean

\n

Whether the user's email address has been verified.

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

id

\n
\n

string

\n

ID of the user.

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

relationships

\n
\n

object

\n

Relationships of the user object returned by the API.

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

org

\n
\n

object

\n

Relationship to an organization.

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

data [required]

\n
\n

object

\n

Relationship to organization object.

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

id [required]

\n
\n

string

\n

ID of the organization.

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

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

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

other_orgs

\n
\n

object

\n

Relationship to organizations.

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

data [required]

\n
\n

[object]

\n

Relationships to organization objects.

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

id [required]

\n
\n

string

\n

ID of the organization.

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

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

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

other_users

\n
\n

object

\n

Relationship to users.

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

data [required]

\n
\n

[object]

\n

Relationships to user objects.

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

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

roles

\n
\n

object

\n

Relationship to roles.

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

data

\n
\n

[object]

\n

An array containing type and the unique identifier of a role.

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

id

\n
\n

string

\n

The unique identifier of the role.

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

type

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

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

type

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

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

included

\n
\n

[ <oneOf>]

\n

Array of objects related to the users.

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

Option 1

\n
\n

object

\n

Organization object.

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

attributes

\n
\n

object

\n

Attributes of the organization.

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

created_at

\n
\n

date-time

\n

Creation time of the organization.

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

description

\n
\n

string

\n

Description of the organization.

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

disabled

\n
\n

boolean

\n

Whether or not the organization is disabled.

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

modified_at

\n
\n

date-time

\n

Time of last organization modification.

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

name

\n
\n

string

\n

Name of the organization.

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

public_id

\n
\n

string

\n

Public ID of the organization.

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

sharing

\n
\n

string

\n

Sharing type of the organization.

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

url

\n
\n

string

\n

URL of the site that this organization exists at.

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

id

\n
\n

string

\n

ID of the organization.

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

type [required]

\n
\n

enum

\n

Organizations resource type. \nAllowed enum values: orgs

default: orgs

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

Option 2

\n
\n

object

\n

Permission object.

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

attributes

\n
\n

object

\n

Attributes of a permission.

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

created

\n
\n

date-time

\n

Creation time of the permission.

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

description

\n
\n

string

\n

Description of the permission.

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

display_name

\n
\n

string

\n

Displayed name for the permission.

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

display_type

\n
\n

string

\n

Display type.

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

group_name

\n
\n

string

\n

Name of the permission group.

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

name

\n
\n

string

\n

Name of the permission.

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

name_aliases

\n
\n

[string]

\n

List of alias names for the permission.

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

restricted

\n
\n

boolean

\n

Whether or not the permission is restricted.

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

id

\n
\n

string

\n

ID of the permission.

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

type [required]

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

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

Option 3

\n
\n

object

\n

Role object returned by the API.

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

attributes

\n
\n

object

\n

Attributes of the role.

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

created_at

\n
\n

date-time

\n

Creation time of the role.

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

modified_at

\n
\n

date-time

\n

Time of last role modification.

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

name

\n
\n

string

\n

The name of the role. The name is neither unique nor a stable identifier of the role.

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

receives_permissions_from

\n
\n

[string]

\n

The managed role from which this role automatically inherits new permissions.\nSpecify one of the following: "Datadog Admin Role", "Datadog Standard Role", or "Datadog Read Only Role".\nIf empty or not specified, the role does not automatically inherit permissions from any managed role.

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

user_count

\n
\n

int64

\n

Number of users with that role.

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

id

\n
\n

string

\n

The unique identifier of the role.

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

relationships

\n
\n

object

\n

Relationships of the role object returned by the API.

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

permissions

\n
\n

object

\n

Relationship to multiple permissions objects.

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

data

\n
\n

[object]

\n

Relationships to permission objects.

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

id

\n
\n

string

\n

ID of the permission.

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

type

\n
\n

enum

\n

Permissions resource type. \nAllowed enum values: permissions

default: permissions

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

type [required]

\n
\n

enum

\n

Roles type. \nAllowed enum values: roles

default: roles

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

meta

\n
\n

object

\n

Object describing meta attributes of response.

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

page

\n
\n

object

\n

Pagination object.

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

total_count

\n
\n

int64

\n

Total count.

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

total_filtered_count

\n
\n

int64

\n

Total count of elements matched by the filter.

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \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": "" + } + } +} \ No newline at end of file diff --git a/content/en/api/v2/org-authorized-clients/_index.md b/content/en/api/v2/org-authorized-clients/_index.md new file mode 100644 index 00000000000..d16f688d0d9 --- /dev/null +++ b/content/en/api/v2/org-authorized-clients/_index.md @@ -0,0 +1,4 @@ +--- +title: Org Authorized Clients +headless: true +--- diff --git a/content/en/api/v2/org-authorized-clients/examples.json b/content/en/api/v2/org-authorized-clients/examples.json new file mode 100644 index 00000000000..380f5fe01fd --- /dev/null +++ b/content/en/api/v2/org-authorized-clients/examples.json @@ -0,0 +1,557 @@ +{ + "ListOrgAuthorizedClients": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "disabled": false, + "last_exercised": "2024-01-15T10:30:00+00:00", + "user_count": 2 + }, + "id": "00000000-0000-0000-0000-000000000001", + "relationships": { + "oauth2_client": { + "data": { + "id": "00000000-0000-0000-0000-000000000010", + "type": "oauth2_clients" + } + }, + "user_authorized_clients": { + "data": [ + { + "id": "00000000-0000-0000-0000-000000000020", + "type": "user_authorized_clients" + } + ], + "links": { + "related": "/api/v2/org_authorized_clients/00000000-0000-0000-0000-000000000001/user_authorized_clients" + } + } + }, + "type": "org_authorized_clients" + } + ], + "meta": { + "page": { + "total_count": "integer", + "total_filtered_count": "integer" + } + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of org authorized client data objects.

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

attributes [required]

\n
\n

object

\n

Attributes of an org authorized client.

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

disabled [required]

\n
\n

boolean

\n

Whether the organization has disabled this client.

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

last_exercised [required]

\n
\n

date-time

\n

The date and time this client was last exercised.

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

user_count [required]

\n
\n

int64

\n

The number of users in the organization who have authorized this client.

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

id [required]

\n
\n

string

\n

The unique identifier of the org authorized client.

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

relationships [required]

\n
\n

object

\n

Relationships for an org authorized client.

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

oauth2_client [required]

\n
\n

object

\n

Relationship to the OAuth2 client for this org authorized client.

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

data [required]

\n
\n

object

\n

Data identifying the OAuth2 client associated with this org authorized client.

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

id [required]

\n
\n

string

\n

The ID of the OAuth2 client.

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

type [required]

\n
\n

enum

\n

OAuth2 client resource type. \nAllowed enum values: oauth2_clients

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

user_authorized_clients [required]

\n
\n

object

\n

Relationship to the user authorized clients for this org authorized client.

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

data [required]

\n
\n

[object]

\n

List of user authorized client relationship data objects.

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

id [required]

\n
\n

string

\n

The ID of the user authorized client.

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

type [required]

\n
\n

enum

\n

User authorized client resource type. \nAllowed enum values: user_authorized_clients

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

links [required]

\n
\n

object

\n

Links for the user authorized clients relationship.

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

related [required]

\n
\n

string

\n

Link to the user authorized clients for this org authorized client.

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

type [required]

\n
\n

enum

\n

The resource type for org authorized clients. \nAllowed enum values: org_authorized_clients

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

meta [required]

\n
\n

object

\n

Object describing meta attributes of response.

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

page

\n
\n

object

\n

Pagination object.

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

total_count

\n
\n

int64

\n

Total count.

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

total_filtered_count

\n
\n

int64

\n

Total count of elements matched by the filter.

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \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": "" + } + }, + "DeleteOrgAuthorizedClient": { + "responses": { + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \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": "" + } + }, + "GetOrgAuthorizedClient": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "disabled": false, + "last_exercised": "2024-01-15T10:30:00+00:00", + "user_count": 2 + }, + "id": "00000000-0000-0000-0000-000000000001", + "relationships": { + "oauth2_client": { + "data": { + "id": "00000000-0000-0000-0000-000000000010", + "type": "oauth2_clients" + } + }, + "user_authorized_clients": { + "data": [ + { + "id": "00000000-0000-0000-0000-000000000020", + "type": "user_authorized_clients" + } + ], + "links": { + "related": "/api/v2/org_authorized_clients/00000000-0000-0000-0000-000000000001/user_authorized_clients" + } + } + }, + "type": "org_authorized_clients" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object representing an org authorized client.

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

attributes [required]

\n
\n

object

\n

Attributes of an org authorized client.

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

disabled [required]

\n
\n

boolean

\n

Whether the organization has disabled this client.

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

last_exercised [required]

\n
\n

date-time

\n

The date and time this client was last exercised.

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

user_count [required]

\n
\n

int64

\n

The number of users in the organization who have authorized this client.

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

id [required]

\n
\n

string

\n

The unique identifier of the org authorized client.

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

relationships [required]

\n
\n

object

\n

Relationships for an org authorized client.

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

oauth2_client [required]

\n
\n

object

\n

Relationship to the OAuth2 client for this org authorized client.

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

data [required]

\n
\n

object

\n

Data identifying the OAuth2 client associated with this org authorized client.

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

id [required]

\n
\n

string

\n

The ID of the OAuth2 client.

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

type [required]

\n
\n

enum

\n

OAuth2 client resource type. \nAllowed enum values: oauth2_clients

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

user_authorized_clients [required]

\n
\n

object

\n

Relationship to the user authorized clients for this org authorized client.

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

data [required]

\n
\n

[object]

\n

List of user authorized client relationship data objects.

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

id [required]

\n
\n

string

\n

The ID of the user authorized client.

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

type [required]

\n
\n

enum

\n

User authorized client resource type. \nAllowed enum values: user_authorized_clients

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

links [required]

\n
\n

object

\n

Links for the user authorized clients relationship.

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

related [required]

\n
\n

string

\n

Link to the user authorized clients for this org authorized client.

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

type [required]

\n
\n

enum

\n

The resource type for org authorized clients. \nAllowed enum values: org_authorized_clients

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \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": "" + } + }, + "UpdateOrgAuthorizedClient": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "disabled": false, + "last_exercised": "2024-01-15T10:30:00+00:00", + "user_count": 2 + }, + "id": "00000000-0000-0000-0000-000000000001", + "relationships": { + "oauth2_client": { + "data": { + "id": "00000000-0000-0000-0000-000000000010", + "type": "oauth2_clients" + } + }, + "user_authorized_clients": { + "data": [ + { + "id": "00000000-0000-0000-0000-000000000020", + "type": "user_authorized_clients" + } + ], + "links": { + "related": "/api/v2/org_authorized_clients/00000000-0000-0000-0000-000000000001/user_authorized_clients" + } + } + }, + "type": "org_authorized_clients" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object representing an org authorized client.

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

attributes [required]

\n
\n

object

\n

Attributes of an org authorized client.

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

disabled [required]

\n
\n

boolean

\n

Whether the organization has disabled this client.

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

last_exercised [required]

\n
\n

date-time

\n

The date and time this client was last exercised.

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

user_count [required]

\n
\n

int64

\n

The number of users in the organization who have authorized this client.

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

id [required]

\n
\n

string

\n

The unique identifier of the org authorized client.

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

relationships [required]

\n
\n

object

\n

Relationships for an org authorized client.

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

oauth2_client [required]

\n
\n

object

\n

Relationship to the OAuth2 client for this org authorized client.

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

data [required]

\n
\n

object

\n

Data identifying the OAuth2 client associated with this org authorized client.

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

id [required]

\n
\n

string

\n

The ID of the OAuth2 client.

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

type [required]

\n
\n

enum

\n

OAuth2 client resource type. \nAllowed enum values: oauth2_clients

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

user_authorized_clients [required]

\n
\n

object

\n

Relationship to the user authorized clients for this org authorized client.

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

data [required]

\n
\n

[object]

\n

List of user authorized client relationship data objects.

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

id [required]

\n
\n

string

\n

The ID of the user authorized client.

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

type [required]

\n
\n

enum

\n

User authorized client resource type. \nAllowed enum values: user_authorized_clients

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

links [required]

\n
\n

object

\n

Links for the user authorized clients relationship.

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

related [required]

\n
\n

string

\n

Link to the user authorized clients for this org authorized client.

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

type [required]

\n
\n

enum

\n

The resource type for org authorized clients. \nAllowed enum values: org_authorized_clients

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "422": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "id": "00000000-0000-0000-0000-000000000001", + "type": "org_authorized_clients" + } + }, + "json": { + "data": { + "attributes": { + "disabled": true + }, + "id": "00000000-0000-0000-0000-000000000001", + "type": "org_authorized_clients" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for updating an org authorized client.

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

attributes

\n
\n

object

\n

Attributes for updating an org authorized client.

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

disabled

\n
\n

boolean

\n

Whether to disable or enable this client for the organization.

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

id [required]

\n
\n

string

\n

The unique identifier of the org authorized client to update.

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

type [required]

\n
\n

enum

\n

The resource type for org authorized clients. \nAllowed enum values: org_authorized_clients

\n
\n \n
\n
\n
\n
" + } + }, + "DeleteOrgAuthorizedClientAllUserAuthorizations": { + "responses": { + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \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": "" + } + }, + "ListOrgAuthorizedClientUserAuthorizations": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "created_at": "2024-01-10T08:00:00+00:00", + "disabled": false, + "last_exercised": "2024-01-15T10:30:00+00:00", + "modified_at": "2024-01-10T08:00:00+00:00", + "org_disabled": false + }, + "id": "00000000-0000-0000-0000-000000000001", + "relationships": { + "oauth2_client": { + "data": { + "id": "00000000-0000-0000-0000-000000000010", + "type": "oauth2_clients" + } + }, + "scopes": { + "data": [ + { + "id": "example_scope", + "type": "scopes" + } + ] + }, + "user": { + "data": { + "id": "00000000-0000-9999-0000-000000000001", + "type": "users" + } + } + }, + "type": "user_authorized_clients" + } + ], + "meta": { + "page": { + "total_count": "integer", + "total_filtered_count": "integer" + } + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of user authorized client data objects.

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

attributes [required]

\n
\n

object

\n

Attributes of a user authorized client.

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

created_at [required]

\n
\n

date-time

\n

The date and time this authorization was created.

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

disabled [required]

\n
\n

boolean

\n

Whether the user has disabled this authorization.

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

last_exercised [required]

\n
\n

date-time

\n

The date and time this authorization was last exercised.

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

modified_at [required]

\n
\n

date-time

\n

The date and time this authorization was last modified.

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

org_disabled [required]

\n
\n

boolean

\n

Whether the organization has disabled this authorization.

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

id [required]

\n
\n

string

\n

The unique identifier of the user authorized client.

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

relationships [required]

\n
\n

object

\n

Relationships for a user authorized client.

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

oauth2_client [required]

\n
\n

object

\n

Relationship to the OAuth2 client that was authorized.

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

data [required]

\n
\n

object

\n

Data identifying the OAuth2 client that was authorized.

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

id [required]

\n
\n

string

\n

The ID of the OAuth2 client.

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

type [required]

\n
\n

enum

\n

OAuth2 client resource type. \nAllowed enum values: oauth2_clients

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

scopes [required]

\n
\n

object

\n

Relationship to the scopes granted to the OAuth2 client.

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

data [required]

\n
\n

[object]

\n

List of scope relationship data objects.

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

id [required]

\n
\n

string

\n

The identifier of the scope.

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

type [required]

\n
\n

enum

\n

Scope resource type. \nAllowed enum values: scopes

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

user [required]

\n
\n

object

\n

Relationship to the user who granted this authorization.

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

data [required]

\n
\n

object

\n

Data identifying the user who granted this authorization.

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

id [required]

\n
\n

string

\n

The ID of the user.

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

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: users

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

type [required]

\n
\n

enum

\n

The resource type for user authorized clients. \nAllowed enum values: user_authorized_clients

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

meta [required]

\n
\n

object

\n

Object describing meta attributes of response.

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

page

\n
\n

object

\n

Pagination object.

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

total_count

\n
\n

int64

\n

Total count.

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

total_filtered_count

\n
\n

int64

\n

Total count of elements matched by the filter.

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \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": "" + } + }, + "DeleteOrgAuthorizedClientUserAuthorization": { + "responses": { + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \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": "" + } + } +} \ No newline at end of file diff --git a/content/en/api/v2/user-authorized-clients/_index.md b/content/en/api/v2/user-authorized-clients/_index.md new file mode 100644 index 00000000000..14c1d3032b9 --- /dev/null +++ b/content/en/api/v2/user-authorized-clients/_index.md @@ -0,0 +1,4 @@ +--- +title: User Authorized Clients +headless: true +--- diff --git a/content/en/api/v2/user-authorized-clients/examples.json b/content/en/api/v2/user-authorized-clients/examples.json new file mode 100644 index 00000000000..b5cd13ceb4f --- /dev/null +++ b/content/en/api/v2/user-authorized-clients/examples.json @@ -0,0 +1,280 @@ +{ + "ListUserAuthorizedClients": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "created_at": "2024-01-10T08:00:00+00:00", + "disabled": false, + "last_exercised": "2024-01-15T10:30:00+00:00", + "modified_at": "2024-01-10T08:00:00+00:00", + "org_disabled": false + }, + "id": "00000000-0000-0000-0000-000000000001", + "relationships": { + "oauth2_client": { + "data": { + "id": "00000000-0000-0000-0000-000000000010", + "type": "oauth2_clients" + } + }, + "scopes": { + "data": [ + { + "id": "example_scope", + "type": "scopes" + } + ] + }, + "user": { + "data": { + "id": "00000000-0000-9999-0000-000000000001", + "type": "users" + } + } + }, + "type": "user_authorized_clients" + } + ], + "meta": { + "page": { + "total_count": "integer", + "total_filtered_count": "integer" + } + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of user authorized client data objects.

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

attributes [required]

\n
\n

object

\n

Attributes of a user authorized client.

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

created_at [required]

\n
\n

date-time

\n

The date and time this authorization was created.

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

disabled [required]

\n
\n

boolean

\n

Whether the user has disabled this authorization.

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

last_exercised [required]

\n
\n

date-time

\n

The date and time this authorization was last exercised.

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

modified_at [required]

\n
\n

date-time

\n

The date and time this authorization was last modified.

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

org_disabled [required]

\n
\n

boolean

\n

Whether the organization has disabled this authorization.

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

id [required]

\n
\n

string

\n

The unique identifier of the user authorized client.

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

relationships [required]

\n
\n

object

\n

Relationships for a user authorized client.

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

oauth2_client [required]

\n
\n

object

\n

Relationship to the OAuth2 client that was authorized.

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

data [required]

\n
\n

object

\n

Data identifying the OAuth2 client that was authorized.

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

id [required]

\n
\n

string

\n

The ID of the OAuth2 client.

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

type [required]

\n
\n

enum

\n

OAuth2 client resource type. \nAllowed enum values: oauth2_clients

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

scopes [required]

\n
\n

object

\n

Relationship to the scopes granted to the OAuth2 client.

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

data [required]

\n
\n

[object]

\n

List of scope relationship data objects.

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

id [required]

\n
\n

string

\n

The identifier of the scope.

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

type [required]

\n
\n

enum

\n

Scope resource type. \nAllowed enum values: scopes

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

user [required]

\n
\n

object

\n

Relationship to the user who granted this authorization.

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

data [required]

\n
\n

object

\n

Data identifying the user who granted this authorization.

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

id [required]

\n
\n

string

\n

The ID of the user.

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

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: users

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

type [required]

\n
\n

enum

\n

The resource type for user authorized clients. \nAllowed enum values: user_authorized_clients

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

meta [required]

\n
\n

object

\n

Object describing meta attributes of response.

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

page

\n
\n

object

\n

Pagination object.

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

total_count

\n
\n

int64

\n

Total count.

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

total_filtered_count

\n
\n

int64

\n

Total count of elements matched by the filter.

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \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": "" + } + }, + "DeleteUserAuthorizedClientsByClient": { + "responses": { + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \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": "" + } + }, + "DeleteUserAuthorizedClient": { + "responses": { + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \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": "" + } + }, + "GetUserAuthorizedClient": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "created_at": "2024-01-10T08:00:00+00:00", + "disabled": false, + "last_exercised": "2024-01-15T10:30:00+00:00", + "modified_at": "2024-01-10T08:00:00+00:00", + "org_disabled": false + }, + "id": "00000000-0000-0000-0000-000000000001", + "relationships": { + "oauth2_client": { + "data": { + "id": "00000000-0000-0000-0000-000000000010", + "type": "oauth2_clients" + } + }, + "scopes": { + "data": [ + { + "id": "example_scope", + "type": "scopes" + } + ] + }, + "user": { + "data": { + "id": "00000000-0000-9999-0000-000000000001", + "type": "users" + } + } + }, + "type": "user_authorized_clients" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object representing a user authorized client.

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

attributes [required]

\n
\n

object

\n

Attributes of a user authorized client.

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

created_at [required]

\n
\n

date-time

\n

The date and time this authorization was created.

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

disabled [required]

\n
\n

boolean

\n

Whether the user has disabled this authorization.

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

last_exercised [required]

\n
\n

date-time

\n

The date and time this authorization was last exercised.

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

modified_at [required]

\n
\n

date-time

\n

The date and time this authorization was last modified.

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

org_disabled [required]

\n
\n

boolean

\n

Whether the organization has disabled this authorization.

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

id [required]

\n
\n

string

\n

The unique identifier of the user authorized client.

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

relationships [required]

\n
\n

object

\n

Relationships for a user authorized client.

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

oauth2_client [required]

\n
\n

object

\n

Relationship to the OAuth2 client that was authorized.

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

data [required]

\n
\n

object

\n

Data identifying the OAuth2 client that was authorized.

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

id [required]

\n
\n

string

\n

The ID of the OAuth2 client.

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

type [required]

\n
\n

enum

\n

OAuth2 client resource type. \nAllowed enum values: oauth2_clients

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

scopes [required]

\n
\n

object

\n

Relationship to the scopes granted to the OAuth2 client.

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

data [required]

\n
\n

[object]

\n

List of scope relationship data objects.

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

id [required]

\n
\n

string

\n

The identifier of the scope.

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

type [required]

\n
\n

enum

\n

Scope resource type. \nAllowed enum values: scopes

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

user [required]

\n
\n

object

\n

Relationship to the user who granted this authorization.

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

data [required]

\n
\n

object

\n

Data identifying the user who granted this authorization.

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

id [required]

\n
\n

string

\n

The ID of the user.

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

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: users

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

type [required]

\n
\n

enum

\n

The resource type for user authorized clients. \nAllowed enum values: user_authorized_clients

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \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": "" + } + } +} \ No newline at end of file diff --git a/content/en/api/v2/users/examples.json b/content/en/api/v2/users/examples.json index 4242e5dc038..89aa22492cc 100644 --- a/content/en/api/v2/users/examples.json +++ b/content/en/api/v2/users/examples.json @@ -974,6 +974,53 @@ "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object to update a user.

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

attributes [required]

\n
\n

object

\n

Attributes of the edited user.

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

disabled

\n
\n

boolean

\n

When set to true, the user is deactivated and can no longer log in.\nWhen false, the user is active.

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

email

\n
\n

string

\n

The email address of the user, used for login and notifications.\nMust be a valid email format.

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

name

\n
\n

string

\n

The full display name of the user as shown in the Datadog UI.\nMaximum 55 characters, cannot contain < or >.

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

title

\n
\n

string

\n

The job title of the user (for example, "Senior Engineer" or "Product Manager").

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

id [required]

\n
\n

string

\n

ID of the user.

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

type [required]

\n
\n

enum

\n

Users resource type. \nAllowed enum values: users

default: users

\n
\n \n
\n
\n
\n
" } }, + "GetUserIdentityProviders": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "authentication_method": "SAML" + }, + "id": "00000000-0000-0000-0000-000000000001", + "type": "identity_providers" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of user identity provider override data objects.

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

attributes [required]

\n
\n

object

\n

Attributes of an identity provider override for a user.

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

authentication_method [required]

\n
\n

string

\n

The authentication method used by this identity provider.

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

id [required]

\n
\n

string

\n

The unique identifier of the identity provider.

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

type [required]

\n
\n

enum

\n

The resource type for identity providers. \nAllowed enum values: identity_providers

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, "DeleteUserInvitations": { "responses": { "403": { @@ -1166,5 +1213,60 @@ "json": {}, "html": "" } + }, + "UpdateUserIdentityProviders": { + "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
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": [ + { + "id": "00000000-0000-0000-0000-000000000001", + "type": "identity_providers" + } + ] + }, + "json": { + "data": [ + { + "id": "00000000-0000-0000-0000-000000000001", + "type": "identity_providers" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of identity provider resource identifiers for a relationship update.

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

id [required]

\n
\n

string

\n

The unique identifier of the identity provider.

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

type [required]

\n
\n

enum

\n

The resource type for identity providers. \nAllowed enum values: identity_providers

\n
\n \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 e9366822d61..2650d2d1932 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -682,6 +682,14 @@ components: required: true schema: type: string + IdentityProviderId: + description: The ID of the identity provider. + in: path + name: idp_id + required: true + schema: + example: "00000000-0000-0000-0000-000000000001" + type: string IncidentIDPathParameter: description: The UUID of the incident. in: path @@ -1086,6 +1094,14 @@ components: required: true schema: type: string + OAuth2ClientId: + description: The ID of the OAuth2 client. + in: path + name: client_id + required: true + schema: + example: "00000000-0000-0000-0000-000000000010" + type: string OAuthClientUUIDPathParameter: description: UUID of the OAuth2 client. in: path @@ -1117,6 +1133,14 @@ components: required: true schema: type: string + OrgAuthorizedClientId: + description: The ID of the org authorized client. + in: path + name: org_authorized_client_id + required: true + schema: + example: "00000000-0000-0000-0000-000000000001" + type: string OrgConfigName: description: The name of an Org Config. in: path @@ -1814,6 +1838,22 @@ components: required: true schema: type: string + UserAuthorizedClientId: + description: The ID of the user authorized client. + in: path + name: user_authorized_client_id + required: true + schema: + example: "00000000-0000-0000-0000-000000000001" + type: string + UserAuthorizedClientIdForOrg: + description: The ID of the user authorized client. + in: path + name: user_authorized_client_id + required: true + schema: + example: "00000000-0000-0000-0000-000000000002" + type: string UserID: description: "The ID of the user." in: path @@ -1822,6 +1862,14 @@ components: schema: example: "00000000-0000-9999-0000-000000000000" type: string + UserIdForOrgClient: + description: The ID of the user. + in: path + name: user_id + required: true + schema: + example: "00000000-0000-9999-0000-000000000001" + type: string UserUUIDPathParameter: description: The UUID of the user to add or remove as a watcher. example: "8146583c-0b5f-11ec-abf8-da7ad0900001" @@ -41467,6 +41515,100 @@ components: type: string x-mimetype: application/xml type: object + IdentityProviderAttributes: + description: Attributes of an organization identity provider. + properties: + authentication_method: + description: The authentication method used by this identity provider. + example: "SAML" + type: string + enabled: + description: Whether this identity provider is enabled for the organization. + example: true + type: boolean + required: + - authentication_method + - enabled + type: object + IdentityProviderData: + description: Data object representing an organization identity provider. + properties: + attributes: + $ref: "#/components/schemas/IdentityProviderAttributes" + id: + description: The unique identifier of the identity provider. + example: "00000000-0000-0000-0000-000000000001" + type: string + type: + $ref: "#/components/schemas/IdentityProviderType" + required: + - id + - type + - attributes + type: object + IdentityProviderDataList: + description: List of organization identity provider data objects. + items: + $ref: "#/components/schemas/IdentityProviderData" + type: array + IdentityProviderResponse: + description: Response containing a single organization identity provider. + properties: + data: + $ref: "#/components/schemas/IdentityProviderData" + required: + - data + type: object + IdentityProviderType: + description: The resource type for identity providers. + enum: + - identity_providers + example: identity_providers + type: string + x-enum-varnames: + - IDENTITY_PROVIDERS + IdentityProviderUpdateAttributes: + description: Attributes for updating an organization identity provider. + properties: + enabled: + description: Whether to enable or disable this identity provider for the organization. + example: true + type: boolean + required: + - enabled + type: object + IdentityProviderUpdateData: + description: Data object for updating an organization identity provider. + properties: + attributes: + $ref: "#/components/schemas/IdentityProviderUpdateAttributes" + id: + description: The unique identifier of the identity provider to update. + example: "00000000-0000-0000-0000-000000000001" + type: string + type: + $ref: "#/components/schemas/IdentityProviderType" + required: + - id + - type + - attributes + type: object + IdentityProviderUpdateRequest: + description: Request body for updating an organization identity provider. + properties: + data: + $ref: "#/components/schemas/IdentityProviderUpdateData" + required: + - data + type: object + IdentityProvidersResponse: + description: Response containing a list of identity providers for an organization. + properties: + data: + $ref: "#/components/schemas/IdentityProviderDataList" + required: + - data + type: object IncidentAttachmentType: default: incident_attachments description: The incident attachment resource type. @@ -67195,6 +67337,210 @@ components: - created_at - modified_at type: object + OrgAuthorizedClientAttributes: + description: Attributes of an org authorized client. + properties: + disabled: + description: Whether the organization has disabled this client. + example: false + type: boolean + last_exercised: + description: The date and time this client was last exercised. + example: "2024-01-15T10:30:00+00:00" + format: date-time + nullable: true + type: string + user_count: + description: The number of users in the organization who have authorized this client. + example: 2 + format: int64 + type: integer + required: + - last_exercised + - disabled + - user_count + type: object + OrgAuthorizedClientData: + description: Data object representing an org authorized client. + properties: + attributes: + $ref: "#/components/schemas/OrgAuthorizedClientAttributes" + id: + description: The unique identifier of the org authorized client. + example: "00000000-0000-0000-0000-000000000001" + type: string + relationships: + $ref: "#/components/schemas/OrgAuthorizedClientRelationships" + type: + $ref: "#/components/schemas/OrgAuthorizedClientType" + required: + - id + - type + - attributes + - relationships + type: object + OrgAuthorizedClientDataList: + description: List of org authorized client data objects. + items: + $ref: "#/components/schemas/OrgAuthorizedClientData" + type: array + OrgAuthorizedClientRelationshipOAuth2Client: + description: Relationship to the OAuth2 client for this org authorized client. + properties: + data: + $ref: "#/components/schemas/OrgAuthorizedClientRelationshipOAuth2ClientData" + required: + - data + type: object + OrgAuthorizedClientRelationshipOAuth2ClientData: + description: Data identifying the OAuth2 client associated with this org authorized client. + properties: + id: + description: The ID of the OAuth2 client. + example: "00000000-0000-0000-0000-000000000010" + type: string + type: + $ref: "#/components/schemas/OrgAuthorizedClientRelationshipOAuth2ClientDataType" + required: + - type + - id + type: object + OrgAuthorizedClientRelationshipOAuth2ClientDataType: + description: OAuth2 client resource type. + enum: + - oauth2_clients + example: oauth2_clients + type: string + x-enum-varnames: + - OAUTH2_CLIENTS + OrgAuthorizedClientRelationshipUserAuthorizedClients: + description: Relationship to the user authorized clients for this org authorized client. + properties: + data: + $ref: "#/components/schemas/OrgAuthorizedClientRelationshipUserAuthorizedClientsDataList" + links: + $ref: "#/components/schemas/OrgAuthorizedClientRelationshipUserAuthorizedClientsLinks" + required: + - links + - data + type: object + OrgAuthorizedClientRelationshipUserAuthorizedClientsData: + description: Data identifying a user authorized client. + properties: + id: + description: The ID of the user authorized client. + example: "00000000-0000-0000-0000-000000000020" + type: string + type: + $ref: "#/components/schemas/OrgAuthorizedClientRelationshipUserAuthorizedClientsDataType" + required: + - type + - id + type: object + OrgAuthorizedClientRelationshipUserAuthorizedClientsDataList: + description: List of user authorized client relationship data objects. + items: + $ref: "#/components/schemas/OrgAuthorizedClientRelationshipUserAuthorizedClientsData" + type: array + OrgAuthorizedClientRelationshipUserAuthorizedClientsDataType: + description: User authorized client resource type. + enum: + - user_authorized_clients + example: user_authorized_clients + type: string + x-enum-varnames: + - USER_AUTHORIZED_CLIENTS + OrgAuthorizedClientRelationshipUserAuthorizedClientsLinks: + description: Links for the user authorized clients relationship. + properties: + related: + description: Link to the user authorized clients for this org authorized client. + example: "/api/v2/org_authorized_clients/00000000-0000-0000-0000-000000000001/user_authorized_clients" + type: string + required: + - related + type: object + OrgAuthorizedClientRelationships: + description: Relationships for an org authorized client. + properties: + oauth2_client: + $ref: "#/components/schemas/OrgAuthorizedClientRelationshipOAuth2Client" + user_authorized_clients: + $ref: "#/components/schemas/OrgAuthorizedClientRelationshipUserAuthorizedClients" + required: + - oauth2_client + - user_authorized_clients + type: object + OrgAuthorizedClientResponse: + description: Response containing a single org authorized client. + properties: + data: + $ref: "#/components/schemas/OrgAuthorizedClientData" + required: + - data + type: object + OrgAuthorizedClientType: + description: The resource type for org authorized clients. + enum: + - org_authorized_clients + example: org_authorized_clients + type: string + x-enum-varnames: + - ORG_AUTHORIZED_CLIENTS + OrgAuthorizedClientUpdateAttributes: + description: Attributes for updating an org authorized client. + properties: + disabled: + description: Whether to disable or enable this client for the organization. + example: true + type: boolean + type: object + OrgAuthorizedClientUpdateData: + description: Data object for updating an org authorized client. + properties: + attributes: + $ref: "#/components/schemas/OrgAuthorizedClientUpdateAttributes" + id: + description: The unique identifier of the org authorized client to update. + example: "00000000-0000-0000-0000-000000000001" + type: string + type: + $ref: "#/components/schemas/OrgAuthorizedClientType" + required: + - id + - type + type: object + OrgAuthorizedClientUpdateRequest: + description: Request body for updating an org authorized client. + properties: + data: + $ref: "#/components/schemas/OrgAuthorizedClientUpdateData" + required: + - data + type: object + OrgAuthorizedClientUserAuthorizationsSort: + description: Field to sort user authorizations by. + enum: + - user.name + - user.email + - oauth2_client.name + example: user.name + type: string + x-enum-varnames: + - USER_NAME + - USER_EMAIL + - OAUTH2_CLIENT_NAME + OrgAuthorizedClientsResponse: + description: Response containing a list of org authorized clients. + properties: + data: + $ref: "#/components/schemas/OrgAuthorizedClientDataList" + meta: + $ref: "#/components/schemas/ResponseMetaAttributes" + required: + - data + - meta + type: object OrgConfigGetResponse: description: A response with a single Org Config. properties: @@ -102411,6 +102757,14 @@ components: required: - data type: object + UpdateUserIdentityProvidersRequest: + description: Request body for setting identity provider overrides for a user. + properties: + data: + $ref: "#/components/schemas/UserRelationshipIdentityProviderDataList" + required: + - data + type: object UpdateWorkflowRequest: description: A request object for updating an existing workflow. example: @@ -103049,6 +103403,197 @@ components: - ACTIVE - DEACTIVATED - PENDING + UserAuthorizedClientAttributes: + description: Attributes of a user authorized client. + properties: + created_at: + description: The date and time this authorization was created. + example: "2024-01-10T08:00:00+00:00" + format: date-time + type: string + disabled: + description: Whether the user has disabled this authorization. + example: false + type: boolean + last_exercised: + description: The date and time this authorization was last exercised. + example: "2024-01-15T10:30:00+00:00" + format: date-time + nullable: true + type: string + modified_at: + description: The date and time this authorization was last modified. + example: "2024-01-10T08:00:00+00:00" + format: date-time + type: string + org_disabled: + description: Whether the organization has disabled this authorization. + example: false + type: boolean + required: + - created_at + - modified_at + - last_exercised + - disabled + - org_disabled + type: object + UserAuthorizedClientData: + description: Data object representing a user authorized client. + properties: + attributes: + $ref: "#/components/schemas/UserAuthorizedClientAttributes" + id: + description: The unique identifier of the user authorized client. + example: "00000000-0000-0000-0000-000000000001" + type: string + relationships: + $ref: "#/components/schemas/UserAuthorizedClientRelationships" + type: + $ref: "#/components/schemas/UserAuthorizedClientType" + required: + - id + - type + - attributes + - relationships + type: object + UserAuthorizedClientDataList: + description: List of user authorized client data objects. + items: + $ref: "#/components/schemas/UserAuthorizedClientData" + type: array + UserAuthorizedClientRelationshipOAuth2Client: + description: Relationship to the OAuth2 client that was authorized. + properties: + data: + $ref: "#/components/schemas/UserAuthorizedClientRelationshipOAuth2ClientData" + required: + - data + type: object + UserAuthorizedClientRelationshipOAuth2ClientData: + description: Data identifying the OAuth2 client that was authorized. + properties: + id: + description: The ID of the OAuth2 client. + example: "00000000-0000-0000-0000-000000000010" + type: string + type: + $ref: "#/components/schemas/UserAuthorizedClientRelationshipOAuth2ClientDataType" + required: + - type + - id + type: object + UserAuthorizedClientRelationshipOAuth2ClientDataType: + description: OAuth2 client resource type. + enum: + - oauth2_clients + example: oauth2_clients + type: string + x-enum-varnames: + - OAUTH2_CLIENTS + UserAuthorizedClientRelationshipScopeData: + description: Data identifying a scope granted to the OAuth2 client. + properties: + id: + description: The identifier of the scope. + example: "example_scope" + type: string + type: + $ref: "#/components/schemas/UserAuthorizedClientRelationshipScopeDataType" + required: + - type + - id + type: object + UserAuthorizedClientRelationshipScopeDataList: + description: List of scope relationship data objects. + items: + $ref: "#/components/schemas/UserAuthorizedClientRelationshipScopeData" + type: array + UserAuthorizedClientRelationshipScopeDataType: + description: Scope resource type. + enum: + - scopes + example: scopes + type: string + x-enum-varnames: + - SCOPES + UserAuthorizedClientRelationshipScopes: + description: Relationship to the scopes granted to the OAuth2 client. + properties: + data: + $ref: "#/components/schemas/UserAuthorizedClientRelationshipScopeDataList" + required: + - data + type: object + UserAuthorizedClientRelationshipUser: + description: Relationship to the user who granted this authorization. + properties: + data: + $ref: "#/components/schemas/UserAuthorizedClientRelationshipUserData" + required: + - data + type: object + UserAuthorizedClientRelationshipUserData: + description: Data identifying the user who granted this authorization. + properties: + id: + description: The ID of the user. + example: "00000000-0000-9999-0000-000000000001" + type: string + type: + $ref: "#/components/schemas/UserAuthorizedClientRelationshipUserDataType" + required: + - type + - id + type: object + UserAuthorizedClientRelationshipUserDataType: + description: User resource type. + enum: + - users + example: users + type: string + x-enum-varnames: + - USERS + UserAuthorizedClientRelationships: + description: Relationships for a user authorized client. + properties: + oauth2_client: + $ref: "#/components/schemas/UserAuthorizedClientRelationshipOAuth2Client" + scopes: + $ref: "#/components/schemas/UserAuthorizedClientRelationshipScopes" + user: + $ref: "#/components/schemas/UserAuthorizedClientRelationshipUser" + required: + - user + - oauth2_client + - scopes + type: object + UserAuthorizedClientResponse: + description: Response containing a single user authorized client. + properties: + data: + $ref: "#/components/schemas/UserAuthorizedClientData" + required: + - data + type: object + UserAuthorizedClientType: + description: The resource type for user authorized clients. + enum: + - user_authorized_clients + example: user_authorized_clients + type: string + x-enum-varnames: + - USER_AUTHORIZED_CLIENTS + UserAuthorizedClientsResponse: + description: Response containing a list of user authorized clients. + properties: + data: + $ref: "#/components/schemas/UserAuthorizedClientDataList" + meta: + $ref: "#/components/schemas/ResponseMetaAttributes" + required: + - data + - meta + type: object UserCreateAttributes: description: Attributes of the created user. properties: @@ -103172,6 +103717,53 @@ components: type: string x-enum-varnames: - USER_INVITATIONS + UserOverrideIdentityProviderAttributes: + description: Attributes of an identity provider override for a user. + properties: + authentication_method: + description: The authentication method used by this identity provider. + example: "SAML" + type: string + required: + - authentication_method + type: object + UserOverrideIdentityProviderData: + description: Data object representing a user identity provider override. + properties: + attributes: + $ref: "#/components/schemas/UserOverrideIdentityProviderAttributes" + id: + description: The unique identifier of the identity provider. + example: "00000000-0000-0000-0000-000000000001" + type: string + type: + $ref: "#/components/schemas/UserOverrideIdentityProviderDataType" + required: + - id + - type + - attributes + type: object + UserOverrideIdentityProviderDataList: + description: List of user identity provider override data objects. + items: + $ref: "#/components/schemas/UserOverrideIdentityProviderData" + type: array + UserOverrideIdentityProviderDataType: + description: The resource type for identity providers. + enum: + - identity_providers + example: identity_providers + type: string + x-enum-varnames: + - IDENTITY_PROVIDERS + UserOverrideIdentityProvidersResponse: + description: Response containing a user's identity provider overrides. + properties: + data: + $ref: "#/components/schemas/UserOverrideIdentityProviderDataList" + required: + - data + type: object UserRelationshipData: description: Relationship to user object. properties: @@ -103185,6 +103777,32 @@ components: - id - type type: object + UserRelationshipIdentityProviderData: + description: Resource identifier for an identity provider in a relationship update. + properties: + id: + description: The unique identifier of the identity provider. + example: "00000000-0000-0000-0000-000000000001" + type: string + type: + $ref: "#/components/schemas/UserRelationshipIdentityProviderDataType" + required: + - id + - type + type: object + UserRelationshipIdentityProviderDataList: + description: List of identity provider resource identifiers for a relationship update. + items: + $ref: "#/components/schemas/UserRelationshipIdentityProviderData" + type: array + UserRelationshipIdentityProviderDataType: + description: The resource type for identity providers. + enum: + - identity_providers + example: identity_providers + type: string + x-enum-varnames: + - IDENTITY_PROVIDERS UserRelationships: description: Relationships of the user object. properties: @@ -130320,15 +130938,94 @@ paths: x-unstable: |- **Note**: This endpoint is in public beta and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). - /api/v2/idp/entity_integrations/{integration_id}: - delete: - description: Delete the configuration stored for a given integration in the caller's organization. - operationId: DeleteEntityIntegrationConfig + /api/v2/identity_providers: + get: + description: Get all identity providers available for the current organization. + operationId: ListIdentityProviders + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + authentication_method: "SAML" + enabled: true + id: "00000000-0000-0000-0000-000000000001" + type: identity_providers + - attributes: + authentication_method: google_oidc + enabled: false + id: "00000000-0000-0000-0000-000000000002" + type: identity_providers + - attributes: + authentication_method: standard + enabled: false + id: "00000000-0000-0000-0000-000000000003" + type: identity_providers + schema: + $ref: "#/components/schemas/IdentityProvidersResponse" + description: OK + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Authentication error + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management + summary: List identity providers + tags: + - Identity Providers + x-menu-order: 3 + "x-permission": + operator: OR + permissions: + - org_management + - user_access_manage + /api/v2/identity_providers/{idp_id}: + patch: + description: Enable or disable an identity provider for the current organization. + operationId: UpdateIdentityProvider parameters: - - $ref: "#/components/parameters/EntityIntegrationConfigID" + - $ref: "#/components/parameters/IdentityProviderId" + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + enabled: true + id: "00000000-0000-0000-0000-000000000001" + type: identity_providers + schema: + $ref: "#/components/schemas/IdentityProviderUpdateRequest" + required: true responses: - "204": - description: No Content + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + authentication_method: "SAML" + enabled: true + id: "00000000-0000-0000-0000-000000000001" + type: identity_providers + schema: + $ref: "#/components/schemas/IdentityProviderResponse" + description: OK "400": content: application/json: @@ -130336,49 +131033,94 @@ paths: $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request "403": - $ref: "#/components/responses/NotAuthorizedResponse" + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Authentication error "404": content: application/json: schema: $ref: "#/components/schemas/JSONAPIErrorResponse" - description: Not Found + description: Not found "429": $ref: "#/components/responses/TooManyRequestsResponse" - summary: Delete an entity integration configuration + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management + summary: Update an identity provider tags: - - Entity Integration Configs - x-menu-order: 3 - x-permission: + - Identity Providers + x-codegen-request-body-name: body + x-menu-order: 2 + "x-permission": operator: OR permissions: - - manage_integrations - x-unstable: |- - **Note**: This endpoint is in preview and is subject to change. - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + - org_management + /api/v2/identity_providers/{idp_id}/users: get: - description: Retrieve the configuration currently stored for a given integration in the caller's organization. - operationId: GetEntityIntegrationConfig + description: |- + Get all users in the organization whose login method has been overridden + to use the specified identity provider. + operationId: ListIdentityProviderUsers parameters: - - $ref: "#/components/parameters/EntityIntegrationConfigID" + - $ref: "#/components/parameters/IdentityProviderId" + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" + - description: User attribute to order results by. Options include `email` and `name`. + in: query + name: sort + required: false + schema: + default: email + example: email + type: string + - description: "Direction of sort. Options: `asc`, `desc`." + in: query + name: sort_dir + required: false + schema: + $ref: "#/components/schemas/QuerySortOrder" + - description: Filter users by the given string. Defaults to no filtering. + in: query + name: filter + required: false + schema: + type: string + - description: |- + Filter on status attribute. + Comma-separated list, with possible values `Active`, `Pending`, and `Disabled`. + Defaults to no filtering. + in: query + name: filter[status] + required: false + schema: + example: Active + type: string responses: "200": content: application/json: - example: - data: - attributes: - config: - enabled_repos: - - github_org_name: myorg - hostname: github.com - repo_name: myrepo - integration_id: github - org_id: 1234 - id: 01HJABCD12345678ABCDEFGHIJ - type: entity_integration_configs + examples: + default: + value: + data: + - attributes: + email: example@datadoghq.com + handle: example-user + name: Example User + status: Active + id: "00000000-0000-9999-0000-000000000001" + type: users + meta: + page: + total_count: 1 + total_filtered_count: 1 schema: - $ref: "#/components/schemas/EntityIntegrationConfigResponse" + $ref: "#/components/schemas/UsersResponse" description: OK "400": content: @@ -130386,6 +131128,52 @@ paths: schema: $ref: "#/components/schemas/JSONAPIErrorResponse" description: Bad Request + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Authentication error + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management + summary: List users with an identity provider override + tags: + - Identity Providers + x-menu-order: 1 + x-pagination: + limitParam: page[size] + pageParam: page[number] + resultsPath: data + "x-permission": + operator: OR + permissions: + - org_management + /api/v2/idp/entity_integrations/{integration_id}: + delete: + description: Delete the configuration stored for a given integration in the caller's organization. + operationId: DeleteEntityIntegrationConfig + parameters: + - $ref: "#/components/parameters/EntityIntegrationConfigID" + responses: + "204": + description: No Content + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request "403": $ref: "#/components/responses/NotAuthorizedResponse" "404": @@ -130396,66 +131184,117 @@ paths: description: Not Found "429": $ref: "#/components/responses/TooManyRequestsResponse" - summary: Get an entity integration configuration + summary: Delete an entity integration configuration tags: - Entity Integration Configs - x-menu-order: 1 + x-menu-order: 3 x-permission: operator: OR permissions: - - integrations_read + - manage_integrations x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). - put: - description: |- - Create or replace the configuration for a given integration in the caller's organization. The shape of `data.attributes.config` depends on the integration: - - - For `github`: `config` must contain an `enabled_repos` array of objects with `hostname`, `github_org_name`, and `repo_name`. - - For `jira`: `config` must contain an `enabled_projects` array of objects with `hostname`, `account_id`, and `project_key`. - - For `pagerduty`: `config` must contain an `accounts` array of objects with a required `enabled` boolean and an optional `subdomain` string. - operationId: UpdateEntityIntegrationConfig + get: + description: Retrieve the configuration currently stored for a given integration in the caller's organization. + operationId: GetEntityIntegrationConfig parameters: - $ref: "#/components/parameters/EntityIntegrationConfigID" - requestBody: - content: - application/json: - examples: - default: - summary: GitHub integration configuration - value: - data: - attributes: - config: - enabled_repos: - - github_org_name: myorg - hostname: github.com - repo_name: myrepo - type: entity_integration_config_requests - jira: - summary: Jira integration configuration - value: - data: - attributes: - config: - enabled_projects: - - account_id: "123456789" - hostname: mycompany.atlassian.net - project_key: AAA - type: entity_integration_config_requests - pagerduty: - summary: PagerDuty integration configuration - value: - data: - attributes: - config: - accounts: - - enabled: true - subdomain: mycompany - type: entity_integration_config_requests - schema: - $ref: "#/components/schemas/EntityIntegrationConfigRequest" - required: true + responses: + "200": + content: + application/json: + example: + data: + attributes: + config: + enabled_repos: + - github_org_name: myorg + hostname: github.com + repo_name: myrepo + integration_id: github + org_id: 1234 + id: 01HJABCD12345678ABCDEFGHIJ + type: entity_integration_configs + schema: + $ref: "#/components/schemas/EntityIntegrationConfigResponse" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "403": + $ref: "#/components/responses/NotAuthorizedResponse" + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Get an entity integration configuration + tags: + - Entity Integration Configs + x-menu-order: 1 + x-permission: + operator: OR + permissions: + - integrations_read + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + put: + description: |- + Create or replace the configuration for a given integration in the caller's organization. The shape of `data.attributes.config` depends on the integration: + + - For `github`: `config` must contain an `enabled_repos` array of objects with `hostname`, `github_org_name`, and `repo_name`. + - For `jira`: `config` must contain an `enabled_projects` array of objects with `hostname`, `account_id`, and `project_key`. + - For `pagerduty`: `config` must contain an `accounts` array of objects with a required `enabled` boolean and an optional `subdomain` string. + operationId: UpdateEntityIntegrationConfig + parameters: + - $ref: "#/components/parameters/EntityIntegrationConfigID" + requestBody: + content: + application/json: + examples: + default: + summary: GitHub integration configuration + value: + data: + attributes: + config: + enabled_repos: + - github_org_name: myorg + hostname: github.com + repo_name: myrepo + type: entity_integration_config_requests + jira: + summary: Jira integration configuration + value: + data: + attributes: + config: + enabled_projects: + - account_id: "123456789" + hostname: mycompany.atlassian.net + project_key: AAA + type: entity_integration_config_requests + pagerduty: + summary: PagerDuty integration configuration + value: + data: + attributes: + config: + accounts: + - enabled: true + subdomain: mycompany + type: entity_integration_config_requests + schema: + $ref: "#/components/schemas/EntityIntegrationConfigRequest" + required: true responses: "200": content: @@ -152782,6 +153621,485 @@ paths: x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/org_authorized_clients: + get: + description: Get a list of all OAuth2 clients authorized for the current organization. + operationId: ListOrgAuthorizedClients + parameters: + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" + - description: Field to sort results by. Options include `oauth2_client.name`. + in: query + name: sort + required: false + schema: + default: oauth2_client.name + example: oauth2_client.name + type: string + - description: Filter results by client name, app title, or app description. + in: query + name: filter + required: false + schema: + type: string + - description: Filter results by the OAuth2 client name. + in: query + name: filter[oauth2_client][name] + required: false + schema: + type: string + - description: Filter results by the org-level disabled status. + in: query + name: filter[disabled] + required: false + schema: + type: string + - description: |- + Comma-separated list of related resources to include. + Options: `oauth2_client`, `oauth2_client.app`, `user_authorized_clients.user`. + in: query + name: include + required: false + schema: + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + disabled: false + last_exercised: "2024-01-15T10:30:00+00:00" + user_count: 2 + id: "00000000-0000-0000-0000-000000000001" + relationships: + oauth2_client: + data: + id: "00000000-0000-0000-0000-000000000010" + type: oauth2_clients + user_authorized_clients: + data: + - id: "00000000-0000-0000-0000-000000000020" + type: user_authorized_clients + links: + related: "/api/v2/org_authorized_clients/00000000-0000-0000-0000-000000000001/user_authorized_clients" + type: org_authorized_clients + meta: + page: + total_count: 1 + total_filtered_count: 1 + schema: + $ref: "#/components/schemas/OrgAuthorizedClientsResponse" + description: OK + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Authentication error + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_authorized_apps_read + summary: List org authorized clients + tags: + - Org Authorized Clients + x-menu-order: 7 + x-pagination: + limitParam: page[size] + pageParam: page[number] + resultsPath: data + x-permission: + operator: OR + permissions: + - org_authorized_apps_read + - manage_integrations + /api/v2/org_authorized_clients/{org_authorized_client_id}: + delete: + description: Disable an OAuth2 client authorization for the current organization, revoking access for all users. + operationId: DeleteOrgAuthorizedClient + parameters: + - $ref: "#/components/parameters/OrgAuthorizedClientId" + responses: + "204": + description: No Content + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Authentication error + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_authorized_apps_write + summary: Delete an org authorized client + tags: + - Org Authorized Clients + x-menu-order: 4 + x-permission: + operator: OR + permissions: + - org_authorized_apps_write + get: + description: Get a single OAuth2 client authorized for the current organization. + operationId: GetOrgAuthorizedClient + parameters: + - $ref: "#/components/parameters/OrgAuthorizedClientId" + - description: |- + Comma-separated list of related resources to include. + Options: `oauth2_client`, `oauth2_client.app`, `oauth2_client.scopes`, `user_authorized_clients.user`. + in: query + name: include + required: false + schema: + type: string + - description: Filter included user authorized clients by disabled status. + in: query + name: filter[user_authorized_clients][disabled] + required: false + schema: + type: string + - description: Filter included user authorized clients by user disabled status. + in: query + name: filter[user_authorized_clients][user][disabled] + required: false + schema: + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + disabled: false + last_exercised: "2024-01-15T10:30:00+00:00" + user_count: 2 + id: "00000000-0000-0000-0000-000000000001" + relationships: + oauth2_client: + data: + id: "00000000-0000-0000-0000-000000000010" + type: oauth2_clients + user_authorized_clients: + data: + - id: "00000000-0000-0000-0000-000000000020" + type: user_authorized_clients + links: + related: "/api/v2/org_authorized_clients/00000000-0000-0000-0000-000000000001/user_authorized_clients" + type: org_authorized_clients + schema: + $ref: "#/components/schemas/OrgAuthorizedClientResponse" + description: OK + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Authentication error + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_authorized_apps_read + summary: Get an org authorized client + tags: + - Org Authorized Clients + x-menu-order: 6 + x-permission: + operator: OR + permissions: + - org_authorized_apps_read + patch: + description: Enable or disable an OAuth2 client authorization for the current organization. + operationId: UpdateOrgAuthorizedClient + parameters: + - $ref: "#/components/parameters/OrgAuthorizedClientId" + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + disabled: true + id: "00000000-0000-0000-0000-000000000001" + type: org_authorized_clients + schema: + $ref: "#/components/schemas/OrgAuthorizedClientUpdateRequest" + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + disabled: true + last_exercised: "2024-01-15T10:30:00+00:00" + user_count: 2 + id: "00000000-0000-0000-0000-000000000001" + relationships: + oauth2_client: + data: + id: "00000000-0000-0000-0000-000000000010" + type: oauth2_clients + user_authorized_clients: + data: [] + links: + related: "/api/v2/org_authorized_clients/00000000-0000-0000-0000-000000000001/user_authorized_clients" + type: org_authorized_clients + schema: + $ref: "#/components/schemas/OrgAuthorizedClientResponse" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Authentication error + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "422": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unprocessable Entity + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_authorized_apps_write + summary: Update an org authorized client + tags: + - Org Authorized Clients + x-codegen-request-body-name: body + x-menu-order: 5 + x-permission: + operator: OR + permissions: + - org_authorized_apps_write + /api/v2/org_authorized_clients/{org_authorized_client_id}/user/{user_id}: + delete: + description: Disable all authorizations for a specific user for the specified OAuth2 client in the current organization. + operationId: DeleteOrgAuthorizedClientAllUserAuthorizations + parameters: + - $ref: "#/components/parameters/OrgAuthorizedClientId" + - $ref: "#/components/parameters/UserIdForOrgClient" + responses: + "204": + description: No Content + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Authentication error + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_authorized_apps_write + summary: Delete a user's authorizations for a client + tags: + - Org Authorized Clients + x-menu-order: 1 + x-permission: + operator: OR + permissions: + - org_authorized_apps_write + /api/v2/org_authorized_clients/{org_authorized_client_id}/user_authorized_clients: + get: + description: Get a list of user authorizations for the specified OAuth2 client in the current organization. + operationId: ListOrgAuthorizedClientUserAuthorizations + parameters: + - $ref: "#/components/parameters/OrgAuthorizedClientId" + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" + - description: "Field to sort results by. Options: `user.name`, `user.email`, `oauth2_client.name`." + in: query + name: sort + required: false + schema: + $ref: "#/components/schemas/OrgAuthorizedClientUserAuthorizationsSort" + - description: Filter results by the user authorization disabled status. + in: query + name: filter[disabled] + required: false + schema: + type: string + - description: Filter results by user name. + in: query + name: filter[user][name] + required: false + schema: + type: string + - description: Filter results by user email. + in: query + name: filter[user][email] + required: false + schema: + type: string + - description: Filter results by whether the user is disabled. + in: query + name: filter[user][disabled] + required: false + schema: + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-10T08:00:00+00:00" + disabled: false + last_exercised: "2024-01-15T10:30:00+00:00" + modified_at: "2024-01-10T08:00:00+00:00" + org_disabled: false + id: "00000000-0000-0000-0000-000000000020" + relationships: + oauth2_client: + data: + id: "00000000-0000-0000-0000-000000000010" + type: oauth2_clients + scopes: + data: + - id: "example_scope" + type: scopes + user: + data: + id: "00000000-0000-9999-0000-000000000001" + type: users + type: user_authorized_clients + meta: + page: + total_count: 1 + total_filtered_count: 1 + schema: + $ref: "#/components/schemas/UserAuthorizedClientsResponse" + description: OK + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Authentication error + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_authorized_apps_read + summary: List user authorizations for a client + tags: + - Org Authorized Clients + x-menu-order: 3 + x-pagination: + limitParam: page[size] + pageParam: page[number] + resultsPath: data + x-permission: + operator: OR + permissions: + - org_authorized_apps_read + /api/v2/org_authorized_clients/{org_authorized_client_id}/user_authorized_clients/{user_authorized_client_id}: + delete: + description: Disable a specific user authorization for the specified OAuth2 client in the current organization. + operationId: DeleteOrgAuthorizedClientUserAuthorization + parameters: + - $ref: "#/components/parameters/OrgAuthorizedClientId" + - $ref: "#/components/parameters/UserAuthorizedClientIdForOrg" + responses: + "204": + description: No Content + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Authentication error + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_authorized_apps_write + summary: Delete a user authorization for a client + tags: + - Org Authorized Clients + x-menu-order: 2 + x-permission: + operator: OR + permissions: + - org_authorized_apps_write /api/v2/org_configs: get: description: Returns all Org Configs (name, description, and value). @@ -186679,6 +187997,211 @@ paths: operator: OR permissions: - usage_read + /api/v2/user_authorized_clients: + get: + description: Get a list of all OAuth2 clients authorized by the current user. + operationId: ListUserAuthorizedClients + parameters: + - $ref: "#/components/parameters/PageSize" + - $ref: "#/components/parameters/PageNumber" + - description: Filter results by client name, app title, or app description. + in: query + name: filter + required: false + schema: + type: string + - description: Filter results by the user-level disabled status. + in: query + name: filter[disabled] + required: false + schema: + type: string + - description: "Comma-separated list of related resources to include. Options: `oauth2_client`, `oauth2_client.app`." + in: query + name: include + required: false + schema: + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-10T08:00:00+00:00" + disabled: false + last_exercised: "2024-01-15T10:30:00+00:00" + modified_at: "2024-01-10T08:00:00+00:00" + org_disabled: false + id: "00000000-0000-0000-0000-000000000001" + relationships: + oauth2_client: + data: + id: "00000000-0000-0000-0000-000000000010" + type: oauth2_clients + scopes: + data: + - id: "example_scope" + type: scopes + user: + data: + id: "00000000-0000-9999-0000-000000000001" + type: users + type: user_authorized_clients + meta: + page: + total_count: 1 + total_filtered_count: 1 + schema: + $ref: "#/components/schemas/UserAuthorizedClientsResponse" + description: OK + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Authentication error + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - built_in_features + summary: List user authorized clients + tags: + - User Authorized Clients + x-menu-order: 4 + x-pagination: + limitParam: page[size] + pageParam: page[number] + resultsPath: data + /api/v2/user_authorized_clients/client/{client_id}: + delete: + description: Disable all authorizations the current user has granted to the specified OAuth2 client. + operationId: DeleteUserAuthorizedClientsByClient + parameters: + - $ref: "#/components/parameters/OAuth2ClientId" + responses: + "204": + description: No Content + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Authentication error + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Delete all user authorized clients for a client + tags: + - User Authorized Clients + x-menu-order: 1 + /api/v2/user_authorized_clients/{user_authorized_client_id}: + delete: + description: Disable the current user's authorization for the specified OAuth2 client. + operationId: DeleteUserAuthorizedClient + parameters: + - $ref: "#/components/parameters/UserAuthorizedClientId" + responses: + "204": + description: No Content + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Authentication error + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - built_in_features + summary: Delete a user authorized client + tags: + - User Authorized Clients + x-menu-order: 2 + get: + description: Get a single OAuth2 client authorization for the current user. + operationId: GetUserAuthorizedClient + parameters: + - $ref: "#/components/parameters/UserAuthorizedClientId" + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-10T08:00:00+00:00" + disabled: false + last_exercised: "2024-01-15T10:30:00+00:00" + modified_at: "2024-01-10T08:00:00+00:00" + org_disabled: false + id: "00000000-0000-0000-0000-000000000001" + relationships: + oauth2_client: + data: + id: "00000000-0000-0000-0000-000000000010" + type: oauth2_clients + scopes: + data: + - id: "example_scope" + type: scopes + user: + data: + id: "00000000-0000-9999-0000-000000000001" + type: users + type: user_authorized_clients + schema: + $ref: "#/components/schemas/UserAuthorizedClientResponse" + description: OK + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Authentication error + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - built_in_features + summary: Get a user authorized client + tags: + - User Authorized Clients + x-menu-order: 3 /api/v2/user_invitations: post: description: Sends emails to one or more users inviting them to join the organization. @@ -187134,6 +188657,56 @@ paths: permissions: - user_access_manage - service_account_write + /api/v2/users/{user_id}/identity_providers: + get: + description: |- + Get the identity provider overrides for a specific user in the organization. + When a user has no overrides set, they use the organization's default identity providers. + operationId: GetUserIdentityProviders + parameters: + - $ref: "#/components/parameters/UserID" + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + authentication_method: "SAML" + id: "00000000-0000-0000-0000-000000000001" + type: identity_providers + schema: + $ref: "#/components/schemas/UserOverrideIdentityProvidersResponse" + description: OK + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/APIErrorResponse" + description: Authentication error + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/APIErrorResponse" + description: Not found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_manage + summary: Get identity provider overrides for a user + tags: + - Users + x-menu-order: 14 + "x-permission": + operator: OR + permissions: + - user_access_manage /api/v2/users/{user_id}/invitations: delete: description: |- @@ -187286,6 +188859,64 @@ paths: operator: OR permissions: - user_access_read + /api/v2/users/{user_id}/relationships/identity_providers: + patch: + description: |- + Set the identity provider overrides for a specific user in the organization. + Pass an empty list to remove all overrides, reverting the user to the organization's + default identity providers. + operationId: UpdateUserIdentityProviders + parameters: + - $ref: "#/components/parameters/UserID" + requestBody: + content: + application/json: + examples: + default: + value: + data: + - id: "00000000-0000-0000-0000-000000000001" + type: identity_providers + schema: + $ref: "#/components/schemas/UpdateUserIdentityProvidersRequest" + required: true + responses: + "204": + description: No Content + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/APIErrorResponse" + description: Bad Request + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/APIErrorResponse" + description: Authentication error + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/APIErrorResponse" + description: Not found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - user_access_manage + summary: Update identity provider overrides for a user + tags: + - Users + x-codegen-request-body-name: body + x-menu-order: 15 + "x-permission": + operator: OR + permissions: + - user_access_manage /api/v2/users/{user_uuid}/memberships: get: description: Get a list of memberships for a user @@ -188680,6 +190311,8 @@ tags: This is an enterprise-only feature. Request access by contacting Datadog support, or see the [IP Allowlist page](https://docs.datadoghq.com/account_management/org_settings/ip_allowlist/) for more information. name: IP Allowlist + - description: Manage identity providers and user authentication method overrides. + name: Identity Providers - description: Create, update, delete, and retrieve services which can be associated with incidents. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/) for more information. name: Incident Services - description: Manage incident response, as well as associated attachments, metadata, and todos. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/) for more information. @@ -188828,6 +190461,8 @@ tags: externalDocs: url: https://docs.datadoghq.com/api/latest/opsgenie-integration name: Opsgenie Integration + - description: Manage OAuth2 client authorizations at the organization level. + name: Org Authorized Clients - description: |- Manage connections between organizations. Org connections allow for controlled sharing of data between different Datadog organizations. See the [Cross-Organization Visibiltiy](https://docs.datadoghq.com/account_management/org_settings/cross_org_visibility/) page for more information. name: Org Connections @@ -189019,6 +190654,8 @@ tags: description: Find out more at url: "https://docs.datadoghq.com/account_management/billing/usage_details/" name: Usage Metering + - description: Manage OAuth2 client authorizations at the user level. + name: User Authorized Clients - description: Create, edit, and disable users. externalDocs: url: https://docs.datadoghq.com/account_management/users diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index 64963ee9321..f3dc593d3d3 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -1926,6 +1926,20 @@ "request_description": "", "request_schema_description": "Request payload for creating or updating a HAMR organization connection." }, + "ListIdentityProviders": { + "description": "Get all identity providers available for the current organization.", + "summary": "List identity providers" + }, + "UpdateIdentityProvider": { + "description": "Enable or disable an identity provider for the current organization.", + "summary": "Update an identity provider", + "request_description": "", + "request_schema_description": "Request body for updating an organization identity provider." + }, + "ListIdentityProviderUsers": { + "description": "Get all users in the organization whose login method has been overridden\nto use the specified identity provider.", + "summary": "List users with an identity provider override" + }, "DeleteEntityIntegrationConfig": { "description": "Delete the configuration stored for a given integration in the caller's organization.", "summary": "Delete an entity integration configuration" @@ -3749,6 +3763,36 @@ "request_description": "", "request_schema_description": "Request to update an organization's SAML preferences." }, + "ListOrgAuthorizedClients": { + "description": "Get a list of all OAuth2 clients authorized for the current organization.", + "summary": "List org authorized clients" + }, + "DeleteOrgAuthorizedClient": { + "description": "Disable an OAuth2 client authorization for the current organization, revoking access for all users.", + "summary": "Delete an org authorized client" + }, + "GetOrgAuthorizedClient": { + "description": "Get a single OAuth2 client authorized for the current organization.", + "summary": "Get an org authorized client" + }, + "UpdateOrgAuthorizedClient": { + "description": "Enable or disable an OAuth2 client authorization for the current organization.", + "summary": "Update an org authorized client", + "request_description": "", + "request_schema_description": "Request body for updating an org authorized client." + }, + "DeleteOrgAuthorizedClientAllUserAuthorizations": { + "description": "Disable all authorizations for a specific user for the specified OAuth2 client in the current organization.", + "summary": "Delete a user's authorizations for a client" + }, + "ListOrgAuthorizedClientUserAuthorizations": { + "description": "Get a list of user authorizations for the specified OAuth2 client in the current organization.", + "summary": "List user authorizations for a client" + }, + "DeleteOrgAuthorizedClientUserAuthorization": { + "description": "Disable a specific user authorization for the specified OAuth2 client in the current organization.", + "summary": "Delete a user authorization for a client" + }, "ListOrgConfigs": { "description": "Returns all Org Configs (name, description, and value).", "summary": "List Org Configs" @@ -6272,6 +6316,22 @@ "description": "Get usage attribution types.", "summary": "Get usage attribution types" }, + "ListUserAuthorizedClients": { + "description": "Get a list of all OAuth2 clients authorized by the current user.", + "summary": "List user authorized clients" + }, + "DeleteUserAuthorizedClientsByClient": { + "description": "Disable all authorizations the current user has granted to the specified OAuth2 client.", + "summary": "Delete all user authorized clients for a client" + }, + "DeleteUserAuthorizedClient": { + "description": "Disable the current user's authorization for the specified OAuth2 client.", + "summary": "Delete a user authorized client" + }, + "GetUserAuthorizedClient": { + "description": "Get a single OAuth2 client authorization for the current user.", + "summary": "Get a user authorized client" + }, "SendInvitations": { "description": "Sends emails to one or more users inviting them to join the organization.", "summary": "Send invitation emails", @@ -6306,6 +6366,10 @@ "request_description": "", "request_schema_description": "Update a user." }, + "GetUserIdentityProviders": { + "description": "Get the identity provider overrides for a specific user in the organization.\nWhen a user has no overrides set, they use the organization's default identity providers.", + "summary": "Get identity provider overrides for a user" + }, "DeleteUserInvitations": { "description": "Cancel all pending invitations for a specified user.\nRequires the `user_access_invite` permission.", "summary": "Delete a pending user's invitations" @@ -6318,6 +6382,12 @@ "description": "Get a user permission set. Returns a list of the user’s permissions\ngranted by the associated user's roles.", "summary": "Get a user permissions" }, + "UpdateUserIdentityProviders": { + "description": "Set the identity provider overrides for a specific user in the organization.\nPass an empty list to remove all overrides, reverting the user to the organization's\ndefault identity providers.", + "summary": "Update identity provider overrides for a user", + "request_description": "", + "request_schema_description": "Request body for setting identity provider overrides for a user." + }, "GetUserMemberships": { "description": "Get a list of memberships for a user", "summary": "Get user memberships" diff --git a/data/api/v2/translate_tags.json b/data/api/v2/translate_tags.json index 6c797da35b9..0eee9a374a0 100644 --- a/data/api/v2/translate_tags.json +++ b/data/api/v2/translate_tags.json @@ -223,6 +223,10 @@ "name": "IP Allowlist", "description": "The IP allowlist API is used to manage the IP addresses that\ncan access the Datadog API and web UI. It does not block\naccess to intake APIs or public dashboards.\n\nThis is an enterprise-only feature. Request access by\ncontacting Datadog support, or see the [IP Allowlist page](https://docs.datadoghq.com/account_management/org_settings/ip_allowlist/) for more information." }, + "identity-providers": { + "name": "Identity Providers", + "description": "Manage identity providers and user authentication method overrides." + }, "incident-services": { "name": "Incident Services", "description": "Create, update, delete, and retrieve services which can be associated with incidents. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/) for more information." @@ -319,6 +323,10 @@ "name": "Opsgenie Integration", "description": "Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/)\ndirectly through the Datadog API." }, + "org-authorized-clients": { + "name": "Org Authorized Clients", + "description": "Manage OAuth2 client authorizations at the organization level." + }, "org-connections": { "name": "Org Connections", "description": "Manage connections between organizations. Org connections allow for controlled sharing of data between different Datadog organizations. See the [Cross-Organization Visibiltiy](https://docs.datadoghq.com/account_management/org_settings/cross_org_visibility/) page for more information." @@ -495,6 +503,10 @@ "name": "Usage Metering", "description": "The usage metering API allows you to get hourly, daily, and\nmonthly usage across multiple facets of Datadog.\nThis API is available to all Pro and Enterprise customers.\n\n**Note**: Usage data is delayed by up to 72 hours from when it was incurred.\nIt is retained for 15 months.\n\nYou can retrieve up to 24 hours of hourly usage data for multiple organizations,\nand up to two months of hourly usage data for a single organization in one request.\nLearn more on the [usage details documentation](https://docs.datadoghq.com/account_management/billing/usage_details/)." }, + "user-authorized-clients": { + "name": "User Authorized Clients", + "description": "Manage OAuth2 client authorizations at the user level." + }, "users": { "name": "Users", "description": "Create, edit, and disable users."