Get an org authorized client

GET https://api.ap1.datadoghq.com/api/v2/org_authorized_clients/{org_authorized_client_id}https://api.ap2.datadoghq.com/api/v2/org_authorized_clients/{org_authorized_client_id}https://api.datadoghq.eu/api/v2/org_authorized_clients/{org_authorized_client_id}https://api.ddog-gov.com/api/v2/org_authorized_clients/{org_authorized_client_id}https://api.us2.ddog-gov.com/api/v2/org_authorized_clients/{org_authorized_client_id}https://api.uk1.datadoghq.com/api/v2/org_authorized_clients/{org_authorized_client_id}https://api.datadoghq.com/api/v2/org_authorized_clients/{org_authorized_client_id}https://api.us3.datadoghq.com/api/v2/org_authorized_clients/{org_authorized_client_id}https://api.us5.datadoghq.com/api/v2/org_authorized_clients/{org_authorized_client_id}

Overview

Get a single OAuth2 client authorized for the current organization. This endpoint requires the org_authorized_apps_read permission.

OAuth apps require the org_authorized_apps_read authorization scope to access this endpoint.

Arguments

Path Parameters

Name

Type

Description

org_authorized_client_id [required]

string

The ID of the org authorized client.

Query Strings

Name

Type

Description

include

string

Comma-separated list of related resources to include. Options: oauth2_client, oauth2_client.app, oauth2_client.scopes, user_authorized_clients.user.

filter[user_authorized_clients][disabled]

string

Filter included user authorized clients by disabled status.

filter[user_authorized_clients][user][disabled]

string

Filter included user authorized clients by user disabled status.

Response

OK

Response containing a single org authorized client.

Expand All

Field

Type

Description

data [required]

object

Data object representing an org authorized client.

attributes [required]

object

Attributes of an org authorized client.

disabled [required]

boolean

Whether the organization has disabled this client.

last_exercised [required]

date-time

The date and time this client was last exercised.

user_count [required]

int64

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

id [required]

string

The unique identifier of the org authorized client.

relationships [required]

object

Relationships for an org authorized client.

oauth2_client [required]

object

Relationship to the OAuth2 client for this org authorized client.

data [required]

object

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

id [required]

string

The ID of the OAuth2 client.

type [required]

enum

OAuth2 client resource type. Allowed enum values: oauth2_clients

user_authorized_clients [required]

object

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

data [required]

[object]

List of user authorized client relationship data objects.

id [required]

string

The ID of the user authorized client.

type [required]

enum

User authorized client resource type. Allowed enum values: user_authorized_clients

links [required]

object

Links for the user authorized clients relationship.

related [required]

string

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

type [required]

enum

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

{
  "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"
  }
}

Authentication error

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

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

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

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

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

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

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

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

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

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

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

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

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

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

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

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

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export org_authorized_client_id="00000000-0000-0000-0000-000000000001"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/org_authorized_clients/${org_authorized_client_id}" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"