Note : This endpoint is in preview and is subject to change.
If you have any feedback, contact Datadog support .
GET https://api.ap1.datadoghq.com/api/v2/oauth2/clients/{client_uuid}/scopes_restriction https://api.ap2.datadoghq.com/api/v2/oauth2/clients/{client_uuid}/scopes_restriction https://api.datadoghq.eu/api/v2/oauth2/clients/{client_uuid}/scopes_restriction https://api.ddog-gov.com/api/v2/oauth2/clients/{client_uuid}/scopes_restriction https://api.us2.ddog-gov.com/api/v2/oauth2/clients/{client_uuid}/scopes_restriction https://api.uk1.datadoghq.com/api/v2/oauth2/clients/{client_uuid}/scopes_restriction https://api.datadoghq.com/api/v2/oauth2/clients/{client_uuid}/scopes_restriction https://api.us3.datadoghq.com/api/v2/oauth2/clients/{client_uuid}/scopes_restriction https://api.us5.datadoghq.com/api/v2/oauth2/clients/{client_uuid}/scopes_restriction
Overview Get the scopes restriction configured for the OAuth2 client.
This endpoint requires the org_authorized_apps_read permission.
Arguments Path Parameters UUID of the OAuth2 client.
Response OK
Response payload describing the scopes restriction of an OAuth2 client.
Expand All
Data object of an OAuth2 client scopes restriction response.
Attributes of an OAuth2 client scopes restriction.
required_permission_scopes [required ]
Permission scopes automatically required for this client (for example, mobile-app permission scopes).
Returns null when no scopes are required.
scopes_restriction [required ]
Allowlist of OIDC and permission scopes enforced for the OAuth2 client.
OIDC scopes the client is restricted to.
permission_scopes [required ]
Datadog permission scopes the client is restricted to.
UUID of the OAuth2 client this restriction applies to.
JSON:API resource type for an OAuth2 client scopes restriction.
Allowed enum values: scopes_restriction
default: scopes_restriction
{
"data" : {
"attributes" : {
"required_permission_scopes" : [
"mobile_app_access"
],
"scopes_restriction" : {
"oidc_scopes" : [
"openid" ,
"email"
],
"permission_scopes" : [
"dashboards_read" ,
"metrics_read"
]
}
},
"id" : "fafa8e1c-36a5-11f0-a83d-da7ad0900001" ,
"type" : "scopes_restriction"
}
} Bad Request
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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
{
"errors" : [
"Bad Request"
]
} Code Example Copy
# Path parameters export client_uuid = "fafa8e1c-36a5-11f0-a83d-da7ad0900001" # 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/oauth2/clients/${client_uuid}/scopes_restriction " \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} "
"""
Get an OAuth2 client scopes restriction returns "OK" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.o_auth2_client_public_api import OAuth2ClientPublicApi
from uuid import UUID
configuration = Configuration ()
configuration . unstable_operations [ "get_scopes_restriction" ] = True
with ApiClient ( configuration ) as api_client :
api_instance = OAuth2ClientPublicApi ( api_client )
response = api_instance . get_scopes_restriction (
client_uuid = UUID ( "fafa8e1c-36a5-11f0-a83d-da7ad0900001" ),
)
print ( response )
Instructions First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" python3 "example.py"
# Get an OAuth2 client scopes restriction returns "OK" response
require "datadog_api_client"
DatadogAPIClient . configure do | config |
config . unstable_operations [ "v2.get_scopes_restriction" . to_sym ] = true
end
api_instance = DatadogAPIClient :: V2 :: OAuth2ClientPublicAPI . new
p api_instance . get_scopes_restriction ( "fafa8e1c-36a5-11f0-a83d-da7ad0900001" )
Instructions First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" rb "example.rb"
// Get an OAuth2 client scopes restriction returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
"github.com/google/uuid"
)
func main () {
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
configuration . SetUnstableOperationEnabled ( "v2.GetScopesRestriction" , true )
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewOAuth2ClientPublicApi ( apiClient )
resp , r , err := api . GetScopesRestriction ( ctx , uuid . MustParse ( "fafa8e1c-36a5-11f0-a83d-da7ad0900001" ))
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `OAuth2ClientPublicApi.GetScopesRestriction`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `OAuth2ClientPublicApi.GetScopesRestriction`:\n%s\n" , responseContent )
}
Instructions First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" go run "main.go"
// Get an OAuth2 client scopes restriction returns "OK" response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v2.api.OAuth2ClientPublicApi ;
import com.datadog.api.client.v2.model.OAuthScopesRestrictionResponse ;
import java.util.UUID ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
defaultClient . setUnstableOperationEnabled ( "v2.getScopesRestriction" , true );
OAuth2ClientPublicApi apiInstance = new OAuth2ClientPublicApi ( defaultClient );
try {
OAuthScopesRestrictionResponse result =
apiInstance . getScopesRestriction ( UUID . fromString ( "fafa8e1c-36a5-11f0-a83d-da7ad0900001" ));
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling OAuth2ClientPublicApi#getScopesRestriction" );
System . err . println ( "Status code: " + e . getCode ());
System . err . println ( "Reason: " + e . getResponseBody ());
System . err . println ( "Response headers: " + e . getResponseHeaders ());
e . printStackTrace ();
}
}
}
Instructions First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" java "Example.java"
// Get an OAuth2 client scopes restriction returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_o_auth2_client_public ::OAuth2ClientPublicAPI ;
use uuid ::Uuid ;
#[tokio::main]
async fn main () {
let mut configuration = datadog ::Configuration ::new ();
configuration . set_unstable_operation_enabled ( "v2.GetScopesRestriction" , true );
let api = OAuth2ClientPublicAPI ::with_config ( configuration );
let resp = api
. get_scopes_restriction (
Uuid ::parse_str ( "fafa8e1c-36a5-11f0-a83d-da7ad0900001" ). expect ( "invalid UUID" ),
)
. await ;
if let Ok ( value ) = resp {
println! ( " {:#?} " , value );
} else {
println! ( " {:#?} " , resp . unwrap_err ());
}
}
Instructions First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" cargo run
/**
* Get an OAuth2 client scopes restriction returns "OK" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
configuration . unstableOperations [ "v2.getScopesRestriction" ] = true ;
const apiInstance = new v2 . OAuth2ClientPublicApi ( configuration );
const params : v2.OAuth2ClientPublicApiGetScopesRestrictionRequest = {
clientUuid : "fafa8e1c-36a5-11f0-a83d-da7ad0900001" ,
};
apiInstance
. getScopesRestriction ( params )
. then (( data : v2.OAuthScopesRestrictionResponse ) => {
console . log (
"API called successfully. Returned data: " + JSON . stringify ( data )
);
})
. catch (( error : any ) => console . error ( error ));
Instructions First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" tsc "example.ts"