--- title: OAuth2 클라이언트 범위 제한 업서트 description: OAuth2 클라이언트에 대해 구성된 범위 제한을 생성하거나 업데이트합니다. breadcrumbs: 문서 > API > OAuth2 클라이언트 범위 제한 업서트 --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/llms.txt). # OAuth2 클라이언트 범위 제한 업서트 ## v2 (latest) {% alert level="warning" %} **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help.md). {% /alert %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------------------------------- | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/oauth2/clients/{client_uuid}/scopes_restriction | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/oauth2/clients/{client_uuid}/scopes_restriction | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/oauth2/clients/{client_uuid}/scopes_restriction | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/oauth2/clients/{client_uuid}/scopes_restriction | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/oauth2/clients/{client_uuid}/scopes_restriction | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/oauth2/clients/{client_uuid}/scopes_restriction | | uk1.datadoghq.com | POST https://api.uk1.datadoghq.com/api/v2/oauth2/clients/{client_uuid}/scopes_restriction | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/oauth2/clients/{client_uuid}/scopes_restriction | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/oauth2/clients/{client_uuid}/scopes_restriction | ### Overview OAuth2 클라이언트에 대해 구성된 범위 제한을 생성하거나 업데이트합니다. This endpoint requires the `org_authorized_apps_write` permission. ### Arguments #### Path Parameters | Field | Type | Description | | ------------------------ | ------ | -------------------------- | | client_uuid [*required*] | string | UUID of the OAuth2 client. | ### Request #### Body Data (required) {% tabs %} {% tab label="Model" %} | Parent field | Field | Type | Description | | ------------ | ----------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | OAuth2 클라이언트의 범위 제한을 생성하거나 업데이트하기 위한 요청 페이로드입니다. | | data | attributes | object | Attributes of an upsert OAuth2 scopes restriction request. | | attributes | oidc_scopes | [string] | OIDC scopes the client is allowed to request. | | attributes | permission_scopes | [string] | Datadog permission scopes the client is allowed to request. Each value must be a valid permission name. | | data | type [*required*] | enum | JSON:API resource type for an upsert OAuth2 client scopes restriction request. Allowed enum values: `upsert_scopes_restriction`. Default: `upsert_scopes_restriction`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "oidc_scopes": [ "openid", "email" ], "permission_scopes": [ "dashboards_read", "metrics_read" ] }, "type": "upsert_scopes_restriction" } } ``` {% /tab %} {% /tabs %} ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Response payload describing the scopes restriction of an OAuth2 client. | Parent field | Field | Type | Description | | ------------------ | --------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Data object of an OAuth2 client scopes restriction response. | | data | attributes [*required*] | object | Attributes of an OAuth2 client scopes restriction. | | attributes | required_permission_scopes [*required*] | [string] | Permission scopes automatically required for this client (for example, mobile-app permission scopes). Returns `null` when no scopes are required. | | attributes | scopes_restriction [*required*] | object | Allowlist of OIDC and permission scopes enforced for the OAuth2 client. | | scopes_restriction | oidc_scopes [*required*] | [string] | OIDC scopes the client is restricted to. | | scopes_restriction | permission_scopes [*required*] | [string] | Datadog permission scopes the client is restricted to. | | data | id [*required*] | uuid | UUID of the OAuth2 client this restriction applies to. | | data | type [*required*] | enum | JSON:API resource type for an OAuth2 client scopes restriction. Allowed enum values: `scopes_restriction`. Default: `scopes_restriction`. | {% /tab %} {% tab label="Example" %} ```json { "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" } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="404" %} Not Found {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export client_uuid="fafa8e1c-36a5-11f0-a83d-da7ad0900001" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X POST "https://api.${DD_SITE}/api/v2/oauth2/clients/${client_uuid}/scopes_restriction" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ -d @- << EOF { "data": { "attributes": { "oidc_scopes": [ "openid", "email" ], "permission_scopes": [ "dashboards_read", "metrics_read" ] }, "type": "upsert_scopes_restriction" } } EOF ``` {% /tab %} {% tab label="Go" %} ```go // Upsert 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() { body := datadogV2.UpsertOAuthScopesRestrictionRequest{ Data: datadogV2.UpsertOAuthScopesRestrictionData{ Attributes: &datadogV2.UpsertOAuthScopesRestrictionDataAttributes{ OidcScopes: []datadogV2.OAuthOidcScope{ datadogV2.OAUTHOIDCSCOPE_OPENID, datadogV2.OAUTHOIDCSCOPE_EMAIL, }, PermissionScopes: []string{ "dashboards_read", "metrics_read", }, }, Type: datadogV2.UPSERTOAUTHSCOPESRESTRICTIONTYPE_UPSERT_SCOPES_RESTRICTION, }, } ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.UpsertScopesRestriction", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewOAuth2ClientPublicApi(apiClient) resp, r, err := api.UpsertScopesRestriction(ctx, uuid.MustParse("fafa8e1c-36a5-11f0-a83d-da7ad0900001"), body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `OAuth2ClientPublicApi.UpsertScopesRestriction`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `OAuth2ClientPublicApi.UpsertScopesRestriction`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Upsert 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.OAuthOidcScope; import com.datadog.api.client.v2.model.OAuthScopesRestrictionResponse; import com.datadog.api.client.v2.model.UpsertOAuthScopesRestrictionData; import com.datadog.api.client.v2.model.UpsertOAuthScopesRestrictionDataAttributes; import com.datadog.api.client.v2.model.UpsertOAuthScopesRestrictionRequest; import com.datadog.api.client.v2.model.UpsertOAuthScopesRestrictionType; import java.util.Arrays; import java.util.UUID; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); defaultClient.setUnstableOperationEnabled("v2.upsertScopesRestriction", true); OAuth2ClientPublicApi apiInstance = new OAuth2ClientPublicApi(defaultClient); UpsertOAuthScopesRestrictionRequest body = new UpsertOAuthScopesRestrictionRequest() .data( new UpsertOAuthScopesRestrictionData() .attributes( new UpsertOAuthScopesRestrictionDataAttributes() .oidcScopes(Arrays.asList(OAuthOidcScope.OPENID, OAuthOidcScope.EMAIL)) .permissionScopes(Arrays.asList("dashboards_read", "metrics_read"))) .type(UpsertOAuthScopesRestrictionType.UPSERT_SCOPES_RESTRICTION)); try { OAuthScopesRestrictionResponse result = apiInstance.upsertScopesRestriction( UUID.fromString("fafa8e1c-36a5-11f0-a83d-da7ad0900001"), body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling OAuth2ClientPublicApi#upsertScopesRestriction"); 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](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Upsert an OAuth2 client scopes restriction returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.o_auth2_client_public_api import OAuth2ClientPublicApi from datadog_api_client.v2.model.o_auth_oidc_scope import OAuthOidcScope from datadog_api_client.v2.model.upsert_o_auth_scopes_restriction_data import UpsertOAuthScopesRestrictionData from datadog_api_client.v2.model.upsert_o_auth_scopes_restriction_data_attributes import ( UpsertOAuthScopesRestrictionDataAttributes, ) from datadog_api_client.v2.model.upsert_o_auth_scopes_restriction_request import UpsertOAuthScopesRestrictionRequest from datadog_api_client.v2.model.upsert_o_auth_scopes_restriction_type import UpsertOAuthScopesRestrictionType from uuid import UUID body = UpsertOAuthScopesRestrictionRequest( data=UpsertOAuthScopesRestrictionData( attributes=UpsertOAuthScopesRestrictionDataAttributes( oidc_scopes=[ OAuthOidcScope.OPENID, OAuthOidcScope.EMAIL, ], permission_scopes=[ "dashboards_read", "metrics_read", ], ), type=UpsertOAuthScopesRestrictionType.UPSERT_SCOPES_RESTRICTION, ), ) configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] configuration.unstable_operations["upsert_scopes_restriction"] = True with ApiClient(configuration) as api_client: api_instance = OAuth2ClientPublicApi(api_client) response = api_instance.upsert_scopes_restriction( client_uuid=UUID("fafa8e1c-36a5-11f0-a83d-da7ad0900001"), body=body ) print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Upsert an OAuth2 client scopes restriction returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] config.unstable_operations["v2.upsert_scopes_restriction".to_sym] = true end api_instance = DatadogAPIClient::V2::OAuth2ClientPublicAPI.new body = DatadogAPIClient::V2::UpsertOAuthScopesRestrictionRequest.new({ data: DatadogAPIClient::V2::UpsertOAuthScopesRestrictionData.new({ attributes: DatadogAPIClient::V2::UpsertOAuthScopesRestrictionDataAttributes.new({ oidc_scopes: [ DatadogAPIClient::V2::OAuthOidcScope::OPENID, DatadogAPIClient::V2::OAuthOidcScope::EMAIL, ], permission_scopes: [ "dashboards_read", "metrics_read", ], }), type: DatadogAPIClient::V2::UpsertOAuthScopesRestrictionType::UPSERT_SCOPES_RESTRICTION, }), }) p api_instance.upsert_scopes_restriction("fafa8e1c-36a5-11f0-a83d-da7ad0900001", body) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Upsert 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 datadog_api_client::datadogV2::model::OAuthOidcScope; use datadog_api_client::datadogV2::model::UpsertOAuthScopesRestrictionData; use datadog_api_client::datadogV2::model::UpsertOAuthScopesRestrictionDataAttributes; use datadog_api_client::datadogV2::model::UpsertOAuthScopesRestrictionRequest; use datadog_api_client::datadogV2::model::UpsertOAuthScopesRestrictionType; use uuid::Uuid; #[tokio::main] async fn main() { let body = UpsertOAuthScopesRestrictionRequest::new( UpsertOAuthScopesRestrictionData::new( UpsertOAuthScopesRestrictionType::UPSERT_SCOPES_RESTRICTION, ) .attributes( UpsertOAuthScopesRestrictionDataAttributes::new() .oidc_scopes(vec![OAuthOidcScope::OPENID, OAuthOidcScope::EMAIL]) .permission_scopes(vec![ "dashboards_read".to_string(), "metrics_read".to_string(), ]), ), ); let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.upsert_scopes_restriction", true); let api = OAuth2ClientPublicAPI::with_config(configuration); let resp = api .upsert_scopes_restriction( Uuid::parse_str("fafa8e1c-36a5-11f0-a83d-da7ad0900001").expect("invalid UUID"), body, ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Upsert an OAuth2 client scopes restriction returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); configuration.unstableOperations["v2.upsertScopesRestriction"] = true; const apiInstance = new v2.OAuth2ClientPublicApi(configuration); const params: v2.OAuth2ClientPublicApiUpsertScopesRestrictionRequest = { body: { data: { attributes: { oidcScopes: ["openid", "email"], permissionScopes: ["dashboards_read", "metrics_read"], }, type: "upsert_scopes_restriction", }, }, clientUuid: "fafa8e1c-36a5-11f0-a83d-da7ad0900001", }; apiInstance .upsertScopesRestriction(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](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %}