- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- Administrator's Guide
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
조직을 생성, 편집, 관리하세요. 자세한 내용은 여러 조직 계정을 참고하세요.
POST https://api.ap1.datadoghq.com/api/v1/orghttps://api.datadoghq.eu/api/v1/orghttps://api.ddog-gov.com/api/v1/orghttps://api.datadoghq.com/api/v1/orghttps://api.us3.datadoghq.com/api/v1/orghttps://api.us5.datadoghq.com/api/v1/org
Create a child organization.
This endpoint requires the multi-organization account feature and must be enabled by contacting support.
Once a new child organization is created, you can interact with it
by using the org.public_id
, api_key.key
, and
application_key.hash
provided in the response.
org_management
permission.Organization object that needs to be created
항목
유형
설명
billing
object
DEPRECATED: A JSON array of billing type.
type
string
The type of billing. Only parent_billing
is supported.
name [required]
string
The name of the new child-organization, limited to 32 characters.
subscription
object
DEPRECATED: Subscription definition.
type
string
The subscription type. Types available are trial
, free
, and pro
.
{
"billing": {
"type": "string"
},
"name": "New child org",
"subscription": {
"type": "string"
}
}
OK
Response object for an organization creation.
항목
유형
설명
api_key
object
Datadog API key.
created
string
Date of creation of the API key.
created_by
string
Datadog user handle that created the API key.
key
string
API key.
name
string
Name of your API key.
application_key
object
An application key with its associated metadata.
hash
string
Hash of an application key.
name
string
Name of an application key.
owner
string
Owner of an application key.
org
object
Create, edit, and manage organizations.
billing
object
DEPRECATED: A JSON array of billing type.
type
string
The type of billing. Only parent_billing
is supported.
created
string
Date of the organization creation.
description
string
Description of the organization.
name
string
The name of the child organization, limited to 32 characters.
public_id
string
The public_id
of the organization you are operating within.
settings
object
A JSON array of settings.
private_widget_share
boolean
Whether or not the organization users can share widgets outside of Datadog.
saml
object
Set the boolean property enabled to enable or disable single sign on with SAML. See the SAML documentation for more information about all SAML settings.
enabled
boolean
Whether or not SAML is enabled for this organization.
saml_autocreate_access_role
enum
The access role of the user. Options are st (standard user), adm (admin user), or ro (read-only user).
Allowed enum values: st,adm,ro,ERROR
saml_autocreate_users_domains
object
Has two properties, enabled
(boolean) and domains
, which is a list of domains without the @ symbol.
domains
[string]
List of domains where the SAML automated user creation is enabled.
enabled
boolean
Whether or not the automated user creation based on SAML domain is enabled.
saml_can_be_enabled
boolean
Whether or not SAML can be enabled for this organization.
saml_idp_endpoint
string
Identity provider endpoint for SAML authentication.
saml_idp_initiated_login
object
Has one property enabled (boolean).
saml_idp_metadata_uploaded
boolean
Whether or not a SAML identity provider metadata file was provided to the Datadog organization.
saml_login_url
string
URL for SAML logging.
saml_strict_mode
object
Has one property enabled (boolean).
enabled
boolean
Whether or not the SAML strict mode is enabled. If true, all users must log in with SAML. Learn more on the SAML Strict documentation.
subscription
object
DEPRECATED: Subscription definition.
type
string
The subscription type. Types available are trial
, free
, and pro
.
trial
boolean
Only available for MSP customers. Allows child organizations to be created on a trial plan.
user
object
Create, edit, and disable users.
access_role
enum
The access role of the user. Options are st (standard user), adm (admin user), or ro (read-only user).
Allowed enum values: st,adm,ro,ERROR
disabled
boolean
The new disabled status of the user.
string
The new email of the user.
handle
string
The user handle, must be a valid email.
icon
string
Gravatar icon associated to the user.
name
string
The name of the user.
verified
boolean
Whether or not the user logged in Datadog at least once.
{
"api_key": {
"created": "2019-08-02 15:31:07",
"created_by": "john@example.com",
"key": "1234512345123456abcabc912349abcd",
"name": "example user"
},
"application_key": {
"hash": "1234512345123459cda4eb9ced49a3d84fd0138c",
"name": "example user",
"owner": "example.com"
},
"org": {
"billing": {
"type": "string"
},
"created": "2019-09-26T17:28:28Z",
"description": "some description",
"name": "New child org",
"public_id": "abcdef12345",
"settings": {
"private_widget_share": false,
"saml": {
"enabled": false
},
"saml_autocreate_access_role": "ro",
"saml_autocreate_users_domains": {
"domains": [
"example.com"
],
"enabled": false
},
"saml_can_be_enabled": false,
"saml_idp_endpoint": "https://my.saml.endpoint",
"saml_idp_initiated_login": {
"enabled": false
},
"saml_idp_metadata_uploaded": false,
"saml_login_url": "https://my.saml.login.url",
"saml_strict_mode": {
"enabled": false
}
},
"subscription": {
"type": "string"
},
"trial": false
},
"user": {
"access_role": "ro",
"disabled": false,
"email": "test@datadoghq.com",
"handle": "test@datadoghq.com",
"icon": "/path/to/matching/gravatar/icon",
"name": "test user",
"verified": true
}
}
Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}
Forbidden
Error response object.
{
"errors": [
"Bad Request"
]
}
Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/org" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"name": "New child org"
}
EOF
"""
Create a child organization returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.organizations_api import OrganizationsApi
from datadog_api_client.v1.model.organization_billing import OrganizationBilling
from datadog_api_client.v1.model.organization_create_body import OrganizationCreateBody
from datadog_api_client.v1.model.organization_subscription import OrganizationSubscription
body = OrganizationCreateBody(
billing=OrganizationBilling(
type="parent_billing",
),
name="New child org",
subscription=OrganizationSubscription(
type="pro",
),
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = OrganizationsApi(api_client)
response = api_instance.create_child_org(body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# Create a child organization returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::OrganizationsAPI.new
body = DatadogAPIClient::V1::OrganizationCreateBody.new({
billing: DatadogAPIClient::V1::OrganizationBilling.new({
type: "parent_billing",
}),
name: "New child org",
subscription: DatadogAPIClient::V1::OrganizationSubscription.new({
type: "pro",
}),
})
p api_instance.create_child_org(body)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// Create a child organization 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/datadogV1"
)
func main() {
body := datadogV1.OrganizationCreateBody{
Billing: &datadogV1.OrganizationBilling{
Type: datadog.PtrString("parent_billing"),
},
Name: "New child org",
Subscription: &datadogV1.OrganizationSubscription{
Type: datadog.PtrString("pro"),
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV1.NewOrganizationsApi(apiClient)
resp, r, err := api.CreateChildOrg(ctx, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.CreateChildOrg`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.CreateChildOrg`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Create a child organization returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.OrganizationsApi;
import com.datadog.api.client.v1.model.OrganizationBilling;
import com.datadog.api.client.v1.model.OrganizationCreateBody;
import com.datadog.api.client.v1.model.OrganizationCreateResponse;
import com.datadog.api.client.v1.model.OrganizationSubscription;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
OrganizationCreateBody body =
new OrganizationCreateBody()
.billing(new OrganizationBilling().type("parent_billing"))
.name("New child org")
.subscription(new OrganizationSubscription().type("pro"));
try {
OrganizationCreateResponse result = apiInstance.createChildOrg(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OrganizationsApi#createChildOrg");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
// Create a child organization returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_organizations::OrganizationsAPI;
use datadog_api_client::datadogV1::model::OrganizationBilling;
use datadog_api_client::datadogV1::model::OrganizationCreateBody;
use datadog_api_client::datadogV1::model::OrganizationSubscription;
#[tokio::main]
async fn main() {
let body = OrganizationCreateBody::new("New child org".to_string())
.billing(OrganizationBilling::new().type_("parent_billing".to_string()))
.subscription(OrganizationSubscription::new().type_("pro".to_string()));
let configuration = datadog::Configuration::new();
let api = OrganizationsAPI::with_config(configuration);
let resp = api.create_child_org(body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
* Create a child organization returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.OrganizationsApi(configuration);
const params: v1.OrganizationsApiCreateChildOrgRequest = {
body: {
billing: {
type: "parent_billing",
},
name: "New child org",
subscription: {
type: "pro",
},
},
};
apiInstance
.createChildOrg(params)
.then((data: v1.OrganizationCreateResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
GET https://api.ap1.datadoghq.com/api/v1/orghttps://api.datadoghq.eu/api/v1/orghttps://api.ddog-gov.com/api/v1/orghttps://api.datadoghq.com/api/v1/orghttps://api.us3.datadoghq.com/api/v1/orghttps://api.us5.datadoghq.com/api/v1/org
This endpoint returns data on your top-level organization.
This endpoint requires the org_management
permission.
OK
Response with the list of organizations.
항목
유형
설명
orgs
[object]
Array of organization objects.
billing
object
DEPRECATED: A JSON array of billing type.
type
string
The type of billing. Only parent_billing
is supported.
created
string
Date of the organization creation.
description
string
Description of the organization.
name
string
The name of the child organization, limited to 32 characters.
public_id
string
The public_id
of the organization you are operating within.
settings
object
A JSON array of settings.
private_widget_share
boolean
Whether or not the organization users can share widgets outside of Datadog.
saml
object
Set the boolean property enabled to enable or disable single sign on with SAML. See the SAML documentation for more information about all SAML settings.
enabled
boolean
Whether or not SAML is enabled for this organization.
saml_autocreate_access_role
enum
The access role of the user. Options are st (standard user), adm (admin user), or ro (read-only user).
Allowed enum values: st,adm,ro,ERROR
saml_autocreate_users_domains
object
Has two properties, enabled
(boolean) and domains
, which is a list of domains without the @ symbol.
domains
[string]
List of domains where the SAML automated user creation is enabled.
enabled
boolean
Whether or not the automated user creation based on SAML domain is enabled.
saml_can_be_enabled
boolean
Whether or not SAML can be enabled for this organization.
saml_idp_endpoint
string
Identity provider endpoint for SAML authentication.
saml_idp_initiated_login
object
Has one property enabled (boolean).
saml_idp_metadata_uploaded
boolean
Whether or not a SAML identity provider metadata file was provided to the Datadog organization.
saml_login_url
string
URL for SAML logging.
saml_strict_mode
object
Has one property enabled (boolean).
enabled
boolean
Whether or not the SAML strict mode is enabled. If true, all users must log in with SAML. Learn more on the SAML Strict documentation.
subscription
object
DEPRECATED: Subscription definition.
type
string
The subscription type. Types available are trial
, free
, and pro
.
trial
boolean
Only available for MSP customers. Allows child organizations to be created on a trial plan.
{
"orgs": [
{
"billing": {
"type": "string"
},
"created": "2019-09-26T17:28:28Z",
"description": "some description",
"name": "New child org",
"public_id": "abcdef12345",
"settings": {
"private_widget_share": false,
"saml": {
"enabled": false
},
"saml_autocreate_access_role": "ro",
"saml_autocreate_users_domains": {
"domains": [
"example.com"
],
"enabled": false
},
"saml_can_be_enabled": false,
"saml_idp_endpoint": "https://my.saml.endpoint",
"saml_idp_initiated_login": {
"enabled": false
},
"saml_idp_metadata_uploaded": false,
"saml_login_url": "https://my.saml.login.url",
"saml_strict_mode": {
"enabled": false
}
},
"subscription": {
"type": "string"
},
"trial": false
}
]
}
Forbidden
Error response object.
{
"errors": [
"Bad Request"
]
}
Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/org" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
List your managed organizations returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.organizations_api import OrganizationsApi
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = OrganizationsApi(api_client)
response = api_instance.list_orgs()
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# List your managed organizations returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::OrganizationsAPI.new
p api_instance.list_orgs()
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// List your managed organizations 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/datadogV1"
)
func main() {
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV1.NewOrganizationsApi(apiClient)
resp, r, err := api.ListOrgs(ctx)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.ListOrgs`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.ListOrgs`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// List your managed organizations returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.OrganizationsApi;
import com.datadog.api.client.v1.model.OrganizationListResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
try {
OrganizationListResponse result = apiInstance.listOrgs();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OrganizationsApi#listOrgs");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
// List your managed organizations returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_organizations::OrganizationsAPI;
#[tokio::main]
async fn main() {
let configuration = datadog::Configuration::new();
let api = OrganizationsAPI::with_config(configuration);
let resp = api.list_orgs().await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
* List your managed organizations returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.OrganizationsApi(configuration);
apiInstance
.listOrgs()
.then((data: v1.OrganizationListResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
GET https://api.ap1.datadoghq.com/api/v1/org/{public_id}https://api.datadoghq.eu/api/v1/org/{public_id}https://api.ddog-gov.com/api/v1/org/{public_id}https://api.datadoghq.com/api/v1/org/{public_id}https://api.us3.datadoghq.com/api/v1/org/{public_id}https://api.us5.datadoghq.com/api/v1/org/{public_id}
Get organization information.
이름
유형
설명
public_id [required]
string
The public_id
of the organization you are operating within.
OK
Response with an organization.
항목
유형
설명
org
object
Create, edit, and manage organizations.
billing
object
DEPRECATED: A JSON array of billing type.
type
string
The type of billing. Only parent_billing
is supported.
created
string
Date of the organization creation.
description
string
Description of the organization.
name
string
The name of the child organization, limited to 32 characters.
public_id
string
The public_id
of the organization you are operating within.
settings
object
A JSON array of settings.
private_widget_share
boolean
Whether or not the organization users can share widgets outside of Datadog.
saml
object
Set the boolean property enabled to enable or disable single sign on with SAML. See the SAML documentation for more information about all SAML settings.
enabled
boolean
Whether or not SAML is enabled for this organization.
saml_autocreate_access_role
enum
The access role of the user. Options are st (standard user), adm (admin user), or ro (read-only user).
Allowed enum values: st,adm,ro,ERROR
saml_autocreate_users_domains
object
Has two properties, enabled
(boolean) and domains
, which is a list of domains without the @ symbol.
domains
[string]
List of domains where the SAML automated user creation is enabled.
enabled
boolean
Whether or not the automated user creation based on SAML domain is enabled.
saml_can_be_enabled
boolean
Whether or not SAML can be enabled for this organization.
saml_idp_endpoint
string
Identity provider endpoint for SAML authentication.
saml_idp_initiated_login
object
Has one property enabled (boolean).
saml_idp_metadata_uploaded
boolean
Whether or not a SAML identity provider metadata file was provided to the Datadog organization.
saml_login_url
string
URL for SAML logging.
saml_strict_mode
object
Has one property enabled (boolean).
enabled
boolean
Whether or not the SAML strict mode is enabled. If true, all users must log in with SAML. Learn more on the SAML Strict documentation.
subscription
object
DEPRECATED: Subscription definition.
type
string
The subscription type. Types available are trial
, free
, and pro
.
trial
boolean
Only available for MSP customers. Allows child organizations to be created on a trial plan.
{
"org": {
"billing": {
"type": "string"
},
"created": "2019-09-26T17:28:28Z",
"description": "some description",
"name": "New child org",
"public_id": "abcdef12345",
"settings": {
"private_widget_share": false,
"saml": {
"enabled": false
},
"saml_autocreate_access_role": "ro",
"saml_autocreate_users_domains": {
"domains": [
"example.com"
],
"enabled": false
},
"saml_can_be_enabled": false,
"saml_idp_endpoint": "https://my.saml.endpoint",
"saml_idp_initiated_login": {
"enabled": false
},
"saml_idp_metadata_uploaded": false,
"saml_login_url": "https://my.saml.login.url",
"saml_strict_mode": {
"enabled": false
}
},
"subscription": {
"type": "string"
},
"trial": false
}
}
Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}
Forbidden
Error response object.
{
"errors": [
"Bad Request"
]
}
Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export public_id="abc123"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/org/${public_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Get organization information returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.organizations_api import OrganizationsApi
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = OrganizationsApi(api_client)
response = api_instance.get_org(
public_id="abc123",
)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# Get organization information returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::OrganizationsAPI.new
p api_instance.get_org("abc123")
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// Get organization information 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/datadogV1"
)
func main() {
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV1.NewOrganizationsApi(apiClient)
resp, r, err := api.GetOrg(ctx, "abc123")
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.GetOrg`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.GetOrg`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Get organization information returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.OrganizationsApi;
import com.datadog.api.client.v1.model.OrganizationResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
try {
OrganizationResponse result = apiInstance.getOrg("abc123");
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OrganizationsApi#getOrg");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
// Get organization information returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_organizations::OrganizationsAPI;
#[tokio::main]
async fn main() {
let configuration = datadog::Configuration::new();
let api = OrganizationsAPI::with_config(configuration);
let resp = api.get_org("abc123".to_string()).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
* Get organization information returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.OrganizationsApi(configuration);
const params: v1.OrganizationsApiGetOrgRequest = {
publicId: "abc123",
};
apiInstance
.getOrg(params)
.then((data: v1.OrganizationResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
PUT https://api.ap1.datadoghq.com/api/v1/org/{public_id}https://api.datadoghq.eu/api/v1/org/{public_id}https://api.ddog-gov.com/api/v1/org/{public_id}https://api.datadoghq.com/api/v1/org/{public_id}https://api.us3.datadoghq.com/api/v1/org/{public_id}https://api.us5.datadoghq.com/api/v1/org/{public_id}
Update your organization.
이름
유형
설명
public_id [required]
string
The public_id
of the organization you are operating within.
항목
유형
설명
billing
object
DEPRECATED: A JSON array of billing type.
type
string
The type of billing. Only parent_billing
is supported.
created
string
Date of the organization creation.
description
string
Description of the organization.
name
string
The name of the child organization, limited to 32 characters.
public_id
string
The public_id
of the organization you are operating within.
settings
object
A JSON array of settings.
private_widget_share
boolean
Whether or not the organization users can share widgets outside of Datadog.
saml
object
Set the boolean property enabled to enable or disable single sign on with SAML. See the SAML documentation for more information about all SAML settings.
enabled
boolean
Whether or not SAML is enabled for this organization.
saml_autocreate_access_role
enum
The access role of the user. Options are st (standard user), adm (admin user), or ro (read-only user).
Allowed enum values: st,adm,ro,ERROR
saml_autocreate_users_domains
object
Has two properties, enabled
(boolean) and domains
, which is a list of domains without the @ symbol.
domains
[string]
List of domains where the SAML automated user creation is enabled.
enabled
boolean
Whether or not the automated user creation based on SAML domain is enabled.
saml_can_be_enabled
boolean
Whether or not SAML can be enabled for this organization.
saml_idp_endpoint
string
Identity provider endpoint for SAML authentication.
saml_idp_initiated_login
object
Has one property enabled (boolean).
saml_idp_metadata_uploaded
boolean
Whether or not a SAML identity provider metadata file was provided to the Datadog organization.
saml_login_url
string
URL for SAML logging.
saml_strict_mode
object
Has one property enabled (boolean).
enabled
boolean
Whether or not the SAML strict mode is enabled. If true, all users must log in with SAML. Learn more on the SAML Strict documentation.
subscription
object
DEPRECATED: Subscription definition.
type
string
The subscription type. Types available are trial
, free
, and pro
.
trial
boolean
Only available for MSP customers. Allows child organizations to be created on a trial plan.
{
"billing": {
"type": "string"
},
"description": "some description",
"name": "New child org",
"public_id": "abcdef12345",
"settings": {
"private_widget_share": false,
"saml": {
"enabled": false
},
"saml_autocreate_access_role": "ro",
"saml_autocreate_users_domains": {
"domains": [
"example.com"
],
"enabled": false
},
"saml_can_be_enabled": false,
"saml_idp_endpoint": "https://my.saml.endpoint",
"saml_idp_initiated_login": {
"enabled": false
},
"saml_idp_metadata_uploaded": false,
"saml_login_url": "https://my.saml.login.url",
"saml_strict_mode": {
"enabled": false
}
},
"subscription": {
"type": "string"
},
"trial": false
}
OK
Response with an organization.
항목
유형
설명
org
object
Create, edit, and manage organizations.
billing
object
DEPRECATED: A JSON array of billing type.
type
string
The type of billing. Only parent_billing
is supported.
created
string
Date of the organization creation.
description
string
Description of the organization.
name
string
The name of the child organization, limited to 32 characters.
public_id
string
The public_id
of the organization you are operating within.
settings
object
A JSON array of settings.
private_widget_share
boolean
Whether or not the organization users can share widgets outside of Datadog.
saml
object
Set the boolean property enabled to enable or disable single sign on with SAML. See the SAML documentation for more information about all SAML settings.
enabled
boolean
Whether or not SAML is enabled for this organization.
saml_autocreate_access_role
enum
The access role of the user. Options are st (standard user), adm (admin user), or ro (read-only user).
Allowed enum values: st,adm,ro,ERROR
saml_autocreate_users_domains
object
Has two properties, enabled
(boolean) and domains
, which is a list of domains without the @ symbol.
domains
[string]
List of domains where the SAML automated user creation is enabled.
enabled
boolean
Whether or not the automated user creation based on SAML domain is enabled.
saml_can_be_enabled
boolean
Whether or not SAML can be enabled for this organization.
saml_idp_endpoint
string
Identity provider endpoint for SAML authentication.
saml_idp_initiated_login
object
Has one property enabled (boolean).
saml_idp_metadata_uploaded
boolean
Whether or not a SAML identity provider metadata file was provided to the Datadog organization.
saml_login_url
string
URL for SAML logging.
saml_strict_mode
object
Has one property enabled (boolean).
enabled
boolean
Whether or not the SAML strict mode is enabled. If true, all users must log in with SAML. Learn more on the SAML Strict documentation.
subscription
object
DEPRECATED: Subscription definition.
type
string
The subscription type. Types available are trial
, free
, and pro
.
trial
boolean
Only available for MSP customers. Allows child organizations to be created on a trial plan.
{
"org": {
"billing": {
"type": "string"
},
"created": "2019-09-26T17:28:28Z",
"description": "some description",
"name": "New child org",
"public_id": "abcdef12345",
"settings": {
"private_widget_share": false,
"saml": {
"enabled": false
},
"saml_autocreate_access_role": "ro",
"saml_autocreate_users_domains": {
"domains": [
"example.com"
],
"enabled": false
},
"saml_can_be_enabled": false,
"saml_idp_endpoint": "https://my.saml.endpoint",
"saml_idp_initiated_login": {
"enabled": false
},
"saml_idp_metadata_uploaded": false,
"saml_login_url": "https://my.saml.login.url",
"saml_strict_mode": {
"enabled": false
}
},
"subscription": {
"type": "string"
},
"trial": false
}
}
Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}
Forbidden
Error response object.
{
"errors": [
"Bad Request"
]
}
Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export public_id="abc123"
# Curl command
curl -X PUT "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/org/${public_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{}
EOF
"""
Update your organization returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.organizations_api import OrganizationsApi
from datadog_api_client.v1.model.access_role import AccessRole
from datadog_api_client.v1.model.organization import Organization
from datadog_api_client.v1.model.organization_billing import OrganizationBilling
from datadog_api_client.v1.model.organization_settings import OrganizationSettings
from datadog_api_client.v1.model.organization_settings_saml import OrganizationSettingsSaml
from datadog_api_client.v1.model.organization_settings_saml_autocreate_users_domains import (
OrganizationSettingsSamlAutocreateUsersDomains,
)
from datadog_api_client.v1.model.organization_settings_saml_idp_initiated_login import (
OrganizationSettingsSamlIdpInitiatedLogin,
)
from datadog_api_client.v1.model.organization_settings_saml_strict_mode import OrganizationSettingsSamlStrictMode
from datadog_api_client.v1.model.organization_subscription import OrganizationSubscription
body = Organization(
billing=OrganizationBilling(
type="parent_billing",
),
description="some description",
name="New child org",
public_id="abcdef12345",
settings=OrganizationSettings(
private_widget_share=False,
saml=OrganizationSettingsSaml(
enabled=False,
),
saml_autocreate_access_role=AccessRole.READ_ONLY,
saml_autocreate_users_domains=OrganizationSettingsSamlAutocreateUsersDomains(
domains=[
"example.com",
],
enabled=False,
),
saml_can_be_enabled=False,
saml_idp_endpoint="https://my.saml.endpoint",
saml_idp_initiated_login=OrganizationSettingsSamlIdpInitiatedLogin(
enabled=False,
),
saml_idp_metadata_uploaded=False,
saml_login_url="https://my.saml.login.url",
saml_strict_mode=OrganizationSettingsSamlStrictMode(
enabled=False,
),
),
subscription=OrganizationSubscription(
type="pro",
),
trial=False,
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = OrganizationsApi(api_client)
response = api_instance.update_org(public_id="abc123", body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# Update your organization returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::OrganizationsAPI.new
body = DatadogAPIClient::V1::Organization.new({
billing: DatadogAPIClient::V1::OrganizationBilling.new({
type: "parent_billing",
}),
description: "some description",
name: "New child org",
public_id: "abcdef12345",
settings: DatadogAPIClient::V1::OrganizationSettings.new({
private_widget_share: false,
saml: DatadogAPIClient::V1::OrganizationSettingsSaml.new({
enabled: false,
}),
saml_autocreate_access_role: DatadogAPIClient::V1::AccessRole::READ_ONLY,
saml_autocreate_users_domains: DatadogAPIClient::V1::OrganizationSettingsSamlAutocreateUsersDomains.new({
domains: [
"example.com",
],
enabled: false,
}),
saml_can_be_enabled: false,
saml_idp_endpoint: "https://my.saml.endpoint",
saml_idp_initiated_login: DatadogAPIClient::V1::OrganizationSettingsSamlIdpInitiatedLogin.new({
enabled: false,
}),
saml_idp_metadata_uploaded: false,
saml_login_url: "https://my.saml.login.url",
saml_strict_mode: DatadogAPIClient::V1::OrganizationSettingsSamlStrictMode.new({
enabled: false,
}),
}),
subscription: DatadogAPIClient::V1::OrganizationSubscription.new({
type: "pro",
}),
trial: false,
})
p api_instance.update_org("abc123", body)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// Update your organization 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/datadogV1"
)
func main() {
body := datadogV1.Organization{
Billing: &datadogV1.OrganizationBilling{
Type: datadog.PtrString("parent_billing"),
},
Description: datadog.PtrString("some description"),
Name: datadog.PtrString("New child org"),
PublicId: datadog.PtrString("abcdef12345"),
Settings: &datadogV1.OrganizationSettings{
PrivateWidgetShare: datadog.PtrBool(false),
Saml: &datadogV1.OrganizationSettingsSaml{
Enabled: datadog.PtrBool(false),
},
SamlAutocreateAccessRole: *datadogV1.NewNullableAccessRole(datadogV1.ACCESSROLE_READ_ONLY.Ptr()),
SamlAutocreateUsersDomains: &datadogV1.OrganizationSettingsSamlAutocreateUsersDomains{
Domains: []string{
"example.com",
},
Enabled: datadog.PtrBool(false),
},
SamlCanBeEnabled: datadog.PtrBool(false),
SamlIdpEndpoint: datadog.PtrString("https://my.saml.endpoint"),
SamlIdpInitiatedLogin: &datadogV1.OrganizationSettingsSamlIdpInitiatedLogin{
Enabled: datadog.PtrBool(false),
},
SamlIdpMetadataUploaded: datadog.PtrBool(false),
SamlLoginUrl: datadog.PtrString("https://my.saml.login.url"),
SamlStrictMode: &datadogV1.OrganizationSettingsSamlStrictMode{
Enabled: datadog.PtrBool(false),
},
},
Subscription: &datadogV1.OrganizationSubscription{
Type: datadog.PtrString("pro"),
},
Trial: datadog.PtrBool(false),
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV1.NewOrganizationsApi(apiClient)
resp, r, err := api.UpdateOrg(ctx, "abc123", body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.UpdateOrg`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.UpdateOrg`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Update your organization returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.OrganizationsApi;
import com.datadog.api.client.v1.model.AccessRole;
import com.datadog.api.client.v1.model.Organization;
import com.datadog.api.client.v1.model.OrganizationBilling;
import com.datadog.api.client.v1.model.OrganizationResponse;
import com.datadog.api.client.v1.model.OrganizationSettings;
import com.datadog.api.client.v1.model.OrganizationSettingsSaml;
import com.datadog.api.client.v1.model.OrganizationSettingsSamlAutocreateUsersDomains;
import com.datadog.api.client.v1.model.OrganizationSettingsSamlIdpInitiatedLogin;
import com.datadog.api.client.v1.model.OrganizationSettingsSamlStrictMode;
import com.datadog.api.client.v1.model.OrganizationSubscription;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
Organization body =
new Organization()
.billing(new OrganizationBilling().type("parent_billing"))
.description("some description")
.name("New child org")
.publicId("abcdef12345")
.settings(
new OrganizationSettings()
.privateWidgetShare(false)
.saml(new OrganizationSettingsSaml().enabled(false))
.samlAutocreateAccessRole(AccessRole.READ_ONLY)
.samlAutocreateUsersDomains(
new OrganizationSettingsSamlAutocreateUsersDomains()
.domains(Collections.singletonList("example.com"))
.enabled(false))
.samlCanBeEnabled(false)
.samlIdpEndpoint("https://my.saml.endpoint")
.samlIdpInitiatedLogin(
new OrganizationSettingsSamlIdpInitiatedLogin().enabled(false))
.samlIdpMetadataUploaded(false)
.samlLoginUrl("https://my.saml.login.url")
.samlStrictMode(new OrganizationSettingsSamlStrictMode().enabled(false)))
.subscription(new OrganizationSubscription().type("pro"))
.trial(false);
try {
OrganizationResponse result = apiInstance.updateOrg("abc123", body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OrganizationsApi#updateOrg");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
// Update your organization returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_organizations::OrganizationsAPI;
use datadog_api_client::datadogV1::model::AccessRole;
use datadog_api_client::datadogV1::model::Organization;
use datadog_api_client::datadogV1::model::OrganizationBilling;
use datadog_api_client::datadogV1::model::OrganizationSettings;
use datadog_api_client::datadogV1::model::OrganizationSettingsSaml;
use datadog_api_client::datadogV1::model::OrganizationSettingsSamlAutocreateUsersDomains;
use datadog_api_client::datadogV1::model::OrganizationSettingsSamlIdpInitiatedLogin;
use datadog_api_client::datadogV1::model::OrganizationSettingsSamlStrictMode;
use datadog_api_client::datadogV1::model::OrganizationSubscription;
#[tokio::main]
async fn main() {
let body = Organization::new()
.billing(OrganizationBilling::new().type_("parent_billing".to_string()))
.description("some description".to_string())
.name("New child org".to_string())
.public_id("abcdef12345".to_string())
.settings(
OrganizationSettings::new()
.private_widget_share(false)
.saml(OrganizationSettingsSaml::new().enabled(false))
.saml_autocreate_access_role(Some(AccessRole::READ_ONLY))
.saml_autocreate_users_domains(
OrganizationSettingsSamlAutocreateUsersDomains::new()
.domains(vec!["example.com".to_string()])
.enabled(false),
)
.saml_can_be_enabled(false)
.saml_idp_endpoint("https://my.saml.endpoint".to_string())
.saml_idp_initiated_login(
OrganizationSettingsSamlIdpInitiatedLogin::new().enabled(false),
)
.saml_idp_metadata_uploaded(false)
.saml_login_url("https://my.saml.login.url".to_string())
.saml_strict_mode(OrganizationSettingsSamlStrictMode::new().enabled(false)),
)
.subscription(OrganizationSubscription::new().type_("pro".to_string()))
.trial(false);
let configuration = datadog::Configuration::new();
let api = OrganizationsAPI::with_config(configuration);
let resp = api.update_org("abc123".to_string(), body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
* Update your organization returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.OrganizationsApi(configuration);
const params: v1.OrganizationsApiUpdateOrgRequest = {
body: {
billing: {
type: "parent_billing",
},
description: "some description",
name: "New child org",
publicId: "abcdef12345",
settings: {
privateWidgetShare: false,
saml: {
enabled: false,
},
samlAutocreateAccessRole: "ro",
samlAutocreateUsersDomains: {
domains: ["example.com"],
enabled: false,
},
samlCanBeEnabled: false,
samlIdpEndpoint: "https://my.saml.endpoint",
samlIdpInitiatedLogin: {
enabled: false,
},
samlIdpMetadataUploaded: false,
samlLoginUrl: "https://my.saml.login.url",
samlStrictMode: {
enabled: false,
},
},
subscription: {
type: "pro",
},
trial: false,
},
publicId: "abc123",
};
apiInstance
.updateOrg(params)
.then((data: v1.OrganizationResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
POST https://api.ap1.datadoghq.com/api/v1/org/{public_id}/idp_metadatahttps://api.datadoghq.eu/api/v1/org/{public_id}/idp_metadatahttps://api.ddog-gov.com/api/v1/org/{public_id}/idp_metadatahttps://api.datadoghq.com/api/v1/org/{public_id}/idp_metadatahttps://api.us3.datadoghq.com/api/v1/org/{public_id}/idp_metadatahttps://api.us5.datadoghq.com/api/v1/org/{public_id}/idp_metadata
There are a couple of options for updating the Identity Provider (IdP) metadata from your SAML IdP.
Multipart Form-Data: Post the IdP metadata file using a form post.
XML Body: Post the IdP metadata file as the body of the request.
이름
유형
설명
public_id [required]
string
The public_id
of the organization you are operating with
{
"idp_file": ""
}
OK
The IdP response object.
{
"message": "IdP metadata successfully uploaded for example org"
}
Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}
Forbidden
Error response object.
{
"errors": [
"Bad Request"
]
}
Unsupported Media Type
Error response object.
{
"errors": [
"Bad Request"
]
}
Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export public_id="abc123"
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/org/${public_id}/idp_metadata" \
-H "Accept: application/json" \
-H "Content-Type: multipart/form-data" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-F idp_file=@string
"""
Upload IdP metadata returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.organizations_api import OrganizationsApi
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = OrganizationsApi(api_client)
response = api_instance.upload_idp_for_org(
public_id="abc123",
idp_file=open("./idp_metadata.xml", "rb"),
)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# Upload IdP metadata returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::OrganizationsAPI.new
p api_instance.upload_idp_for_org("abc123", File.open("./idp_metadata.xml", "r"))
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// Upload IdP metadata returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"io"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)
func main() {
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV1.NewOrganizationsApi(apiClient)
resp, r, err := api.UploadIdPForOrg(ctx, "abc123", func() io.Reader { fp, _ := os.Open("./idp_metadata.xml"); return fp }())
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.UploadIdPForOrg`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.UploadIdPForOrg`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Upload IdP metadata returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.OrganizationsApi;
import com.datadog.api.client.v1.model.IdpResponse;
import java.io.File;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
try {
IdpResponse result = apiInstance.uploadIdPForOrg("abc123", new File("./idp_metadata.xml"));
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OrganizationsApi#uploadIdPForOrg");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
// Upload IdP metadata returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_organizations::OrganizationsAPI;
use std::fs;
#[tokio::main]
async fn main() {
let configuration = datadog::Configuration::new();
let api = OrganizationsAPI::with_config(configuration);
let resp = api
.upload_idp_for_org(
"abc123".to_string(),
fs::read("./idp_metadata.xml").unwrap(),
)
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
* Upload IdP metadata returns "OK" response
*/
import * as fs from "fs";
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.OrganizationsApi(configuration);
const params: v1.OrganizationsApiUploadIdPForOrgRequest = {
publicId: "abc123",
idpFile: {
data: Buffer.from(fs.readFileSync("./idp_metadata.xml", "utf8")),
name: "./idp_metadata.xml",
},
};
apiInstance
.uploadIdPForOrg(params)
.then((data: v1.IdpResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
POST https://api.ap1.datadoghq.com/api/v2/saml_configurations/idp_metadatahttps://api.datadoghq.eu/api/v2/saml_configurations/idp_metadatahttps://api.ddog-gov.com/api/v2/saml_configurations/idp_metadatahttps://api.datadoghq.com/api/v2/saml_configurations/idp_metadatahttps://api.us3.datadoghq.com/api/v2/saml_configurations/idp_metadatahttps://api.us5.datadoghq.com/api/v2/saml_configurations/idp_metadata
Endpoint for uploading IdP metadata for SAML setup.
Use this endpoint to upload or replace IdP metadata for SAML login configuration.
This endpoint requires theorg_management
permission.{
"idp_file": "string"
}
OK
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/saml_configurations/idp_metadata" \
-H "Accept: application/json" \
-H "Content-Type: multipart/form-data" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-F idp_file=@string
"""
Upload IdP metadata returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.organizations_api import OrganizationsApi
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = OrganizationsApi(api_client)
api_instance.upload_idp_metadata(
idp_file=open("fixtures/organizations/saml_configurations/valid_idp_metadata.xml", "rb"),
)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# Upload IdP metadata returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::OrganizationsAPI.new
opts = {
idp_file: File.open("fixtures/organizations/saml_configurations/valid_idp_metadata.xml", "r"),
}
p api_instance.upload_idp_metadata(opts)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// Upload IdP metadata returns "OK" response
package main
import (
"context"
"fmt"
"io"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewOrganizationsApi(apiClient)
r, err := api.UploadIdPMetadata(ctx, *datadogV2.NewUploadIdPMetadataOptionalParameters().WithIdpFile(func() io.Reader {
fp, _ := os.Open("fixtures/organizations/saml_configurations/valid_idp_metadata.xml")
return fp
}()))
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.UploadIdPMetadata`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Upload IdP metadata returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.OrganizationsApi;
import com.datadog.api.client.v2.api.OrganizationsApi.UploadIdPMetadataOptionalParameters;
import java.io.File;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
try {
apiInstance.uploadIdPMetadata(
new UploadIdPMetadataOptionalParameters()
.idpFile(
new File("fixtures/organizations/saml_configurations/valid_idp_metadata.xml")));
} catch (ApiException e) {
System.err.println("Exception when calling OrganizationsApi#uploadIdPMetadata");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
// Upload IdP metadata returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_organizations::OrganizationsAPI;
use datadog_api_client::datadogV2::api_organizations::UploadIdPMetadataOptionalParams;
use std::fs;
#[tokio::main]
async fn main() {
let configuration = datadog::Configuration::new();
let api = OrganizationsAPI::with_config(configuration);
let resp = api
.upload_idp_metadata(UploadIdPMetadataOptionalParams::default().idp_file(
fs::read("fixtures/organizations/saml_configurations/valid_idp_metadata.xml").unwrap(),
))
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
* Upload IdP metadata returns "OK" response
*/
import * as fs from "fs";
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.OrganizationsApi(configuration);
const params: v2.OrganizationsApiUploadIdPMetadataRequest = {
idpFile: {
data: Buffer.from(
fs.readFileSync(
"fixtures/organizations/saml_configurations/valid_idp_metadata.xml",
"utf8"
)
),
name: "fixtures/organizations/saml_configurations/valid_idp_metadata.xml",
},
};
apiInstance
.uploadIdPMetadata(params)
.then((data: any) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
POST https://api.ap1.datadoghq.com/api/v1/org/{public_id}/downgradehttps://api.datadoghq.eu/api/v1/org/{public_id}/downgradehttps://api.ddog-gov.com/api/v1/org/{public_id}/downgradehttps://api.datadoghq.com/api/v1/org/{public_id}/downgradehttps://api.us3.datadoghq.com/api/v1/org/{public_id}/downgradehttps://api.us5.datadoghq.com/api/v1/org/{public_id}/downgrade
Only available for MSP customers. Removes a child organization from the hierarchy of the master organization and places the child organization on a 30-day trial.
이름
유형
설명
public_id [required]
string
The public_id
of the organization you are operating within.
OK
Status of downgrade
{
"message": "string"
}
Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}
Forbidden
Error response object.
{
"errors": [
"Bad Request"
]
}
Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export public_id="abc123"
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/org/${public_id}/downgrade" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Spin-off Child Organization returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.organizations_api import OrganizationsApi
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = OrganizationsApi(api_client)
response = api_instance.downgrade_org(
public_id="abc123",
)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# Spin-off Child Organization returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::OrganizationsAPI.new
p api_instance.downgrade_org("abc123")
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// Spin-off Child Organization 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/datadogV1"
)
func main() {
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV1.NewOrganizationsApi(apiClient)
resp, r, err := api.DowngradeOrg(ctx, "abc123")
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.DowngradeOrg`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.DowngradeOrg`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Spin-off Child Organization returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.OrganizationsApi;
import com.datadog.api.client.v1.model.OrgDowngradedResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
try {
OrgDowngradedResponse result = apiInstance.downgradeOrg("abc123");
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OrganizationsApi#downgradeOrg");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
// Spin-off Child Organization returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_organizations::OrganizationsAPI;
#[tokio::main]
async fn main() {
let configuration = datadog::Configuration::new();
let api = OrganizationsAPI::with_config(configuration);
let resp = api.downgrade_org("abc123".to_string()).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
* Spin-off Child Organization returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.OrganizationsApi(configuration);
const params: v1.OrganizationsApiDowngradeOrgRequest = {
publicId: "abc123",
};
apiInstance
.downgradeOrg(params)
.then((data: v1.OrgDowngradedResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
GET https://api.ap1.datadoghq.com/api/v2/org_configshttps://api.datadoghq.eu/api/v2/org_configshttps://api.ddog-gov.com/api/v2/org_configshttps://api.datadoghq.com/api/v2/org_configshttps://api.us3.datadoghq.com/api/v2/org_configshttps://api.us5.datadoghq.com/api/v2/org_configs
Returns all Org Configs (name, description, and value).
OK
A response with multiple Org Configs.
항목
유형
설명
data [required]
[object]
An array of Org Configs.
attributes [required]
object
Readable attributes of an Org Config.
description [required]
string
The description of an Org Config.
modified_at
date-time
The timestamp of the last Org Config update (if any).
name [required]
string
The machine-friendly name of an Org Config.
value [required]
The value of an Org Config.
value_type [required]
string
The type of an Org Config value.
id [required]
string
A unique identifier for an Org Config.
type [required]
enum
Data type of an Org Config.
Allowed enum values: org_configs
{
"data": [
{
"attributes": {
"description": "Frobulate the turbo encabulator manifold",
"modified_at": "2019-09-19T10:00:00.000Z",
"name": "monitor_timezone",
"value": "undefined",
"value_type": "bool"
},
"id": "abcd1234",
"type": "org_configs"
}
]
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Unauthorized
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/org_configs" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
List Org Configs returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.organizations_api import OrganizationsApi
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = OrganizationsApi(api_client)
response = api_instance.list_org_configs()
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# List Org Configs returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::OrganizationsAPI.new
p api_instance.list_org_configs()
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// List Org Configs 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"
)
func main() {
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewOrganizationsApi(apiClient)
resp, r, err := api.ListOrgConfigs(ctx)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.ListOrgConfigs`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.ListOrgConfigs`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// List Org Configs returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.OrganizationsApi;
import com.datadog.api.client.v2.model.OrgConfigListResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
try {
OrgConfigListResponse result = apiInstance.listOrgConfigs();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OrganizationsApi#listOrgConfigs");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
// List Org Configs returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_organizations::OrganizationsAPI;
#[tokio::main]
async fn main() {
let configuration = datadog::Configuration::new();
let api = OrganizationsAPI::with_config(configuration);
let resp = api.list_org_configs().await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
* List Org Configs returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.OrganizationsApi(configuration);
apiInstance
.listOrgConfigs()
.then((data: v2.OrgConfigListResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
GET https://api.ap1.datadoghq.com/api/v2/org_configs/{org_config_name}https://api.datadoghq.eu/api/v2/org_configs/{org_config_name}https://api.ddog-gov.com/api/v2/org_configs/{org_config_name}https://api.datadoghq.com/api/v2/org_configs/{org_config_name}https://api.us3.datadoghq.com/api/v2/org_configs/{org_config_name}https://api.us5.datadoghq.com/api/v2/org_configs/{org_config_name}
Return the name, description, and value of a specific Org Config.
이름
유형
설명
org_config_name [required]
string
The name of an Org Config.
OK
A response with a single Org Config.
항목
유형
설명
data [required]
object
A single Org Config.
attributes [required]
object
Readable attributes of an Org Config.
description [required]
string
The description of an Org Config.
modified_at
date-time
The timestamp of the last Org Config update (if any).
name [required]
string
The machine-friendly name of an Org Config.
value [required]
The value of an Org Config.
value_type [required]
string
The type of an Org Config value.
id [required]
string
A unique identifier for an Org Config.
type [required]
enum
Data type of an Org Config.
Allowed enum values: org_configs
{
"data": {
"attributes": {
"description": "Frobulate the turbo encabulator manifold",
"modified_at": "2019-09-19T10:00:00.000Z",
"name": "monitor_timezone",
"value": "undefined",
"value_type": "bool"
},
"id": "abcd1234",
"type": "org_configs"
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Unauthorized
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export org_config_name="monitor_timezone"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/org_configs/${org_config_name}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Get a specific Org Config value returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.organizations_api import OrganizationsApi
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = OrganizationsApi(api_client)
response = api_instance.get_org_config(
org_config_name="custom_roles",
)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# Get a specific Org Config value returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::OrganizationsAPI.new
p api_instance.get_org_config("custom_roles")
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// Get a specific Org Config value 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"
)
func main() {
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewOrganizationsApi(apiClient)
resp, r, err := api.GetOrgConfig(ctx, "custom_roles")
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.GetOrgConfig`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.GetOrgConfig`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Get a specific Org Config value returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.OrganizationsApi;
import com.datadog.api.client.v2.model.OrgConfigGetResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
try {
OrgConfigGetResponse result = apiInstance.getOrgConfig("custom_roles");
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OrganizationsApi#getOrgConfig");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
// Get a specific Org Config value returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_organizations::OrganizationsAPI;
#[tokio::main]
async fn main() {
let configuration = datadog::Configuration::new();
let api = OrganizationsAPI::with_config(configuration);
let resp = api.get_org_config("custom_roles".to_string()).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
* Get a specific Org Config value returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.OrganizationsApi(configuration);
const params: v2.OrganizationsApiGetOrgConfigRequest = {
orgConfigName: "custom_roles",
};
apiInstance
.getOrgConfig(params)
.then((data: v2.OrgConfigGetResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
PATCH https://api.ap1.datadoghq.com/api/v2/org_configs/{org_config_name}https://api.datadoghq.eu/api/v2/org_configs/{org_config_name}https://api.ddog-gov.com/api/v2/org_configs/{org_config_name}https://api.datadoghq.com/api/v2/org_configs/{org_config_name}https://api.us3.datadoghq.com/api/v2/org_configs/{org_config_name}https://api.us5.datadoghq.com/api/v2/org_configs/{org_config_name}
Update the value of a specific Org Config.
This endpoint requires the org_management
permission.
이름
유형
설명
org_config_name [required]
string
The name of an Org Config.
항목
유형
설명
data [required]
object
An Org Config write operation.
attributes [required]
object
Writable attributes of an Org Config.
value [required]
The value of an Org Config.
type [required]
enum
Data type of an Org Config.
Allowed enum values: org_configs
{
"data": {
"attributes": {
"value": "UTC"
},
"type": "org_configs"
}
}
OK
A response with a single Org Config.
항목
유형
설명
data [required]
object
A single Org Config.
attributes [required]
object
Readable attributes of an Org Config.
description [required]
string
The description of an Org Config.
modified_at
date-time
The timestamp of the last Org Config update (if any).
name [required]
string
The machine-friendly name of an Org Config.
value [required]
The value of an Org Config.
value_type [required]
string
The type of an Org Config value.
id [required]
string
A unique identifier for an Org Config.
type [required]
enum
Data type of an Org Config.
Allowed enum values: org_configs
{
"data": {
"attributes": {
"description": "Frobulate the turbo encabulator manifold",
"modified_at": "2019-09-19T10:00:00.000Z",
"name": "monitor_timezone",
"value": "undefined",
"value_type": "bool"
},
"id": "abcd1234",
"type": "org_configs"
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Unauthorized
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export org_config_name="monitor_timezone"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/org_configs/${org_config_name}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"data": {
"attributes": {
"value": "UTC"
},
"type": "org_configs"
}
}
EOF
// Update a specific Org Config 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"
)
func main() {
body := datadogV2.OrgConfigWriteRequest{
Data: datadogV2.OrgConfigWrite{
Attributes: datadogV2.OrgConfigWriteAttributes{
Value: "UTC",
},
Type: datadogV2.ORGCONFIGTYPE_ORG_CONFIGS,
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewOrganizationsApi(apiClient)
resp, r, err := api.UpdateOrgConfig(ctx, "monitor_timezone", body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `OrganizationsApi.UpdateOrgConfig`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `OrganizationsApi.UpdateOrgConfig`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Update a specific Org Config returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.OrganizationsApi;
import com.datadog.api.client.v2.model.OrgConfigGetResponse;
import com.datadog.api.client.v2.model.OrgConfigType;
import com.datadog.api.client.v2.model.OrgConfigWrite;
import com.datadog.api.client.v2.model.OrgConfigWriteAttributes;
import com.datadog.api.client.v2.model.OrgConfigWriteRequest;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
OrganizationsApi apiInstance = new OrganizationsApi(defaultClient);
OrgConfigWriteRequest body =
new OrgConfigWriteRequest()
.data(
new OrgConfigWrite()
.attributes(new OrgConfigWriteAttributes().value("UTC"))
.type(OrgConfigType.ORG_CONFIGS));
try {
OrgConfigGetResponse result = apiInstance.updateOrgConfig("monitor_timezone", body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OrganizationsApi#updateOrgConfig");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
"""
Update a specific Org Config returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.organizations_api import OrganizationsApi
from datadog_api_client.v2.model.org_config_type import OrgConfigType
from datadog_api_client.v2.model.org_config_write import OrgConfigWrite
from datadog_api_client.v2.model.org_config_write_attributes import OrgConfigWriteAttributes
from datadog_api_client.v2.model.org_config_write_request import OrgConfigWriteRequest
body = OrgConfigWriteRequest(
data=OrgConfigWrite(
attributes=OrgConfigWriteAttributes(
value="UTC",
),
type=OrgConfigType.ORG_CONFIGS,
),
)
configuration = Configuration()