- 重要な情報
- はじめに
- 用語集
- ガイド
- エージェント
- インテグレーション
- OpenTelemetry
- 開発者
- API
- CoScreen
- アプリ内
- Service Management
- インフラストラクチャー
- アプリケーションパフォーマンス
- 継続的インテグレーション
- ログ管理
- セキュリティ
- UX モニタリング
- 管理
Organization を作成、編集、および管理します。マルチ Organization のアカウントについては、こちらを参照してください。
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
子オーガニゼーションを作成します。
このエンドポイントにはマルチオーガニゼーションアカウント 機能が必要です。 サポートに連絡して有効化してください。
新しい子オーガニゼーションが作成されたら、応答で渡されたorg.public_id
、api_key.key
、application_key.hash
を使用して操作することができます。
作成が必要となるオーガニゼーションのオブジェクト
フィールド
種類
説明
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.
The new email of the user.
handle
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
*/
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
このエンドポイントは、トップレベルの組織に関するデータを返します。
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
*/
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}
オーガニゼーションの情報を取得します。
名前
種類
説明
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
*/
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}
オーガニゼーションを更新します。
名前
種類
説明
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
*/
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
SAML IdP に含まれる ID プロバイダー (IdP) のメタデータを 更新するオプションはいくつかあります。
マルチパートフォームデータ: フォームポストを使用して IdP のメタデータファイルをポストします。
XML 本文: IdP のメタデータファイルをリクエスト本文としてポストします。
名前
種類
説明
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
*/
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.
{
"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
*/
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
MSP のお客様のみ利用可能です。マスター組織の階層から子組織を削除し、30 日間の試用期間中に子組織を配置します。
名前
種類
説明
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
*/
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"