Upsert an OAuth2 client scopes restriction
https://api.datadoghq.com/api/v2/oauth2/clients/{client_uuid}/scopes_restrictionhttps://api.us3.datadoghq.com/api/v2/oauth2/clients/{client_uuid}/scopes_restrictionhttps://api.us5.datadoghq.com/api/v2/oauth2/clients/{client_uuid}/scopes_restrictionhttps://api.datadoghq.eu/api/v2/oauth2/clients/{client_uuid}/scopes_restrictionhttps://api.ap1.datadoghq.com/api/v2/oauth2/clients/{client_uuid}/scopes_restrictionhttps://api.ap2.datadoghq.com/api/v2/oauth2/clients/{client_uuid}/scopes_restrictionhttps://api.uk1.datadoghq.com/api/v2/oauth2/clients/{client_uuid}/scopes_restrictionhttps://api.ddog-gov.com/api/v2/oauth2/clients/{client_uuid}/scopes_restrictionhttps://api.us2.ddog-gov.com/api/v2/oauth2/clients/{client_uuid}/scopes_restriction概要
Create or update the scopes restriction configured for the OAuth2 client.
引数
パスパラメーター
client_uuid [required]UUID of the OAuth2 client.
リクエスト
Body Data (required)
data [required]Data object of an upsert OAuth2 scopes restriction request.
attributesAttributes of an upsert OAuth2 scopes restriction request.
oidc_scopesOIDC scopes the client is allowed to request.
permission_scopesDatadog permission scopes the client is allowed to request. Each value must be a valid permission name.
type [required]JSON:API resource type for an upsert OAuth2 client scopes restriction request.
upsert_scopes_restrictionupsert_scopes_restriction{
"data": {
"attributes": {
"oidc_scopes": [
"openid",
"email"
],
"permission_scopes": [
"dashboards_read",
"metrics_read"
]
},
"type": "upsert_scopes_restriction"
}
}応答
OK
Response payload describing the scopes restriction of an OAuth2 client.
data [required]Data object of an OAuth2 client scopes restriction response.
attributes [required]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 [required]OIDC scopes the client is restricted to.
permission_scopes [required]Datadog permission scopes the client is restricted to.
id [required]UUID of the OAuth2 client this restriction applies to.
type [required]JSON:API resource type for an OAuth2 client scopes restriction.
scopes_restrictionscopes_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.
errors [required]A list of errors.
detailA human-readable explanation specific to this occurrence of the error.
metaNon-standard meta-information about the error
sourceReferences to the source of the error.
headerA string indicating the name of a single request header which caused the error.
parameterA string indicating which URI query parameter caused the error.
pointerA JSON pointer to the value in the request document that caused the error.
statusStatus code of the response.
titleShort 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.
errors [required]A list of errors.
detailA human-readable explanation specific to this occurrence of the error.
metaNon-standard meta-information about the error
sourceReferences to the source of the error.
headerA string indicating the name of a single request header which caused the error.
parameterA string indicating which URI query parameter caused the error.
pointerA JSON pointer to the value in the request document that caused the error.
statusStatus code of the response.
titleShort 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.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}コード例
# Path parameters
export client_uuid="fafa8e1c-36a5-11f0-a83d-da7ad0900001"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_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# Path parameters
export client_uuid="fafa8e1c-36a5-11f0-a83d-da7ad0900001"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_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# Path parameters
export client_uuid="fafa8e1c-36a5-11f0-a83d-da7ad0900001"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_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# Path parameters
export client_uuid="fafa8e1c-36a5-11f0-a83d-da7ad0900001"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_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# Path parameters
export client_uuid="fafa8e1c-36a5-11f0-a83d-da7ad0900001"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_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# Path parameters
export client_uuid="fafa8e1c-36a5-11f0-a83d-da7ad0900001"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_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# Path parameters
export client_uuid="fafa8e1c-36a5-11f0-a83d-da7ad0900001"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_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# Path parameters
export client_uuid="fafa8e1c-36a5-11f0-a83d-da7ad0900001"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_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# Path parameters
export client_uuid="fafa8e1c-36a5-11f0-a83d-da7ad0900001"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_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// 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 and then save the example to main.go and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"// 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 and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java""""
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 and then save the example to example.py and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"# 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 and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"// 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 and then save the example to src/main.rs and run following commands:
DD_SITE="datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run/**
* 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 and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"