- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- Administrator's Guide
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
Configure your Datadog Okta integration directly through the Datadog API.
GET https://api.ap1.datadoghq.com/api/v2/integrations/okta/accountshttps://api.datadoghq.eu/api/v2/integrations/okta/accountshttps://api.ddog-gov.com/api/v2/integrations/okta/accountshttps://api.datadoghq.com/api/v2/integrations/okta/accountshttps://api.us3.datadoghq.com/api/v2/integrations/okta/accountshttps://api.us5.datadoghq.com/api/v2/integrations/okta/accounts
List Okta accounts.
This endpoint requires the integrations_read
permission.
OK
The expected response schema when getting Okta accounts.
항목
유형
설명
data
[object]
List of Okta accounts.
attributes [required]
object
Attributes object for an Okta account.
api_key
string
The API key of the Okta account.
auth_method [required]
string
The authorization method for an Okta account.
client_id
string
The Client ID of an Okta app integration.
client_secret
string
The client secret of an Okta app integration.
domain [required]
string
The domain of the Okta account.
name [required]
string
The name of the Okta account.
id [required]
string
The ID of the Okta account, a UUID hash of the account name.
type [required]
enum
Account type for an Okta account.
Allowed enum values: okta-accounts
default: okta-accounts
{
"data": [
{
"attributes": {
"api_key": "string",
"auth_method": "oauth",
"client_id": "string",
"client_secret": "string",
"domain": "https://example.okta.com/",
"name": "Okta-Prod"
},
"id": "f749daaf-682e-4208-a38d-c9b43162c609",
"type": "okta-accounts"
}
]
}
Bad Request
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"
]
}
# List Okta accounts returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::OktaIntegrationAPI.new
p api_instance.list_okta_accounts()
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"
POST https://api.ap1.datadoghq.com/api/v2/integrations/okta/accountshttps://api.datadoghq.eu/api/v2/integrations/okta/accountshttps://api.ddog-gov.com/api/v2/integrations/okta/accountshttps://api.datadoghq.com/api/v2/integrations/okta/accountshttps://api.us3.datadoghq.com/api/v2/integrations/okta/accountshttps://api.us5.datadoghq.com/api/v2/integrations/okta/accounts
Create an Okta account.
This endpoint requires the manage_integrations
permission.
항목
유형
설명
data [required]
object
Schema for an Okta account.
attributes [required]
object
Attributes object for an Okta account.
api_key
string
The API key of the Okta account.
auth_method [required]
string
The authorization method for an Okta account.
client_id
string
The Client ID of an Okta app integration.
client_secret
string
The client secret of an Okta app integration.
domain [required]
string
The domain of the Okta account.
name [required]
string
The name of the Okta account.
id
string
The ID of the Okta account, a UUID hash of the account name.
type [required]
enum
Account type for an Okta account.
Allowed enum values: okta-accounts
default: okta-accounts
{
"data": {
"attributes": {
"auth_method": "oauth",
"domain": "https://example.okta.com/",
"name": "exampleoktaintegration",
"client_id": "client_id",
"client_secret": "client_secret"
},
"id": "f749daaf-682e-4208-a38d-c9b43162c609",
"type": "okta-accounts"
}
}
OK
Response object for an Okta account.
항목
유형
설명
data
object
Schema for an Okta account.
attributes [required]
object
Attributes object for an Okta account.
api_key
string
The API key of the Okta account.
auth_method [required]
string
The authorization method for an Okta account.
client_id
string
The Client ID of an Okta app integration.
client_secret
string
The client secret of an Okta app integration.
domain [required]
string
The domain of the Okta account.
name [required]
string
The name of the Okta account.
id
string
The ID of the Okta account, a UUID hash of the account name.
type [required]
enum
Account type for an Okta account.
Allowed enum values: okta-accounts
default: okta-accounts
{
"data": {
"attributes": {
"api_key": "string",
"auth_method": "oauth",
"client_id": "string",
"client_secret": "string",
"domain": "https://example.okta.com/",
"name": "Okta-Prod"
},
"id": "f749daaf-682e-4208-a38d-c9b43162c609",
"type": "okta-accounts"
}
}
Bad Request
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"
]
}
# Add Okta account returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::OktaIntegrationAPI.new
body = DatadogAPIClient::V2::OktaAccountRequest.new({
data: DatadogAPIClient::V2::OktaAccount.new({
attributes: DatadogAPIClient::V2::OktaAccountAttributes.new({
auth_method: "oauth",
domain: "https://example.okta.com/",
name: "exampleoktaintegration",
client_id: "client_id",
client_secret: "client_secret",
}),
id: "f749daaf-682e-4208-a38d-c9b43162c609",
type: DatadogAPIClient::V2::OktaAccountType::OKTA_ACCOUNTS,
}),
})
p api_instance.create_okta_account(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"
GET https://api.ap1.datadoghq.com/api/v2/integrations/okta/accounts/{account_id}https://api.datadoghq.eu/api/v2/integrations/okta/accounts/{account_id}https://api.ddog-gov.com/api/v2/integrations/okta/accounts/{account_id}https://api.datadoghq.com/api/v2/integrations/okta/accounts/{account_id}https://api.us3.datadoghq.com/api/v2/integrations/okta/accounts/{account_id}https://api.us5.datadoghq.com/api/v2/integrations/okta/accounts/{account_id}
Get an Okta account.
This endpoint requires the integrations_read
permission.
이름
유형
설명
account_id [required]
string
None
OK
Response object for an Okta account.
항목
유형
설명
data
object
Schema for an Okta account.
attributes [required]
object
Attributes object for an Okta account.
api_key
string
The API key of the Okta account.
auth_method [required]
string
The authorization method for an Okta account.
client_id
string
The Client ID of an Okta app integration.
client_secret
string
The client secret of an Okta app integration.
domain [required]
string
The domain of the Okta account.
name [required]
string
The name of the Okta account.
id
string
The ID of the Okta account, a UUID hash of the account name.
type [required]
enum
Account type for an Okta account.
Allowed enum values: okta-accounts
default: okta-accounts
{
"data": {
"attributes": {
"api_key": "string",
"auth_method": "oauth",
"client_id": "string",
"client_secret": "string",
"domain": "https://example.okta.com/",
"name": "Okta-Prod"
},
"id": "f749daaf-682e-4208-a38d-c9b43162c609",
"type": "okta-accounts"
}
}
Bad Request
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"
]
}
# Get Okta account returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::OktaIntegrationAPI.new
# there is a valid "okta_account" in the system
OKTA_ACCOUNT_DATA_ID = ENV["OKTA_ACCOUNT_DATA_ID"]
p api_instance.get_okta_account(OKTA_ACCOUNT_DATA_ID)
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"
PATCH https://api.ap1.datadoghq.com/api/v2/integrations/okta/accounts/{account_id}https://api.datadoghq.eu/api/v2/integrations/okta/accounts/{account_id}https://api.ddog-gov.com/api/v2/integrations/okta/accounts/{account_id}https://api.datadoghq.com/api/v2/integrations/okta/accounts/{account_id}https://api.us3.datadoghq.com/api/v2/integrations/okta/accounts/{account_id}https://api.us5.datadoghq.com/api/v2/integrations/okta/accounts/{account_id}
Update an Okta account.
This endpoint requires the manage_integrations
permission.
이름
유형
설명
account_id [required]
string
None
항목
유형
설명
data [required]
object
Data object for updating an Okta account.
attributes
object
Attributes object for updating an Okta account.
api_key
string
The API key of the Okta account.
auth_method [required]
string
The authorization method for an Okta account.
client_id
string
The Client ID of an Okta app integration.
client_secret
string
The client secret of an Okta app integration.
domain [required]
string
The domain associated with an Okta account.
type
enum
Account type for an Okta account.
Allowed enum values: okta-accounts
default: okta-accounts
{
"data": {
"attributes": {
"auth_method": "oauth",
"domain": "https://example.okta.com/",
"client_id": "client_id",
"client_secret": "client_secret"
},
"type": "okta-accounts"
}
}
OK
Response object for an Okta account.
항목
유형
설명
data
object
Schema for an Okta account.
attributes [required]
object
Attributes object for an Okta account.
api_key
string
The API key of the Okta account.
auth_method [required]
string
The authorization method for an Okta account.
client_id
string
The Client ID of an Okta app integration.
client_secret
string
The client secret of an Okta app integration.
domain [required]
string
The domain of the Okta account.
name [required]
string
The name of the Okta account.
id
string
The ID of the Okta account, a UUID hash of the account name.
type [required]
enum
Account type for an Okta account.
Allowed enum values: okta-accounts
default: okta-accounts
{
"data": {
"attributes": {
"api_key": "string",
"auth_method": "oauth",
"client_id": "string",
"client_secret": "string",
"domain": "https://example.okta.com/",
"name": "Okta-Prod"
},
"id": "f749daaf-682e-4208-a38d-c9b43162c609",
"type": "okta-accounts"
}
}
Bad Request
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"
]
}
# Update Okta account returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::OktaIntegrationAPI.new
# there is a valid "okta_account" in the system
OKTA_ACCOUNT_DATA_ID = ENV["OKTA_ACCOUNT_DATA_ID"]
body = DatadogAPIClient::V2::OktaAccountUpdateRequest.new({
data: DatadogAPIClient::V2::OktaAccountUpdateRequestData.new({
attributes: DatadogAPIClient::V2::OktaAccountUpdateRequestAttributes.new({
auth_method: "oauth",
domain: "https://example.okta.com/",
client_id: "client_id",
client_secret: "client_secret",
}),
type: DatadogAPIClient::V2::OktaAccountType::OKTA_ACCOUNTS,
}),
})
p api_instance.update_okta_account(OKTA_ACCOUNT_DATA_ID, 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"
DELETE https://api.ap1.datadoghq.com/api/v2/integrations/okta/accounts/{account_id}https://api.datadoghq.eu/api/v2/integrations/okta/accounts/{account_id}https://api.ddog-gov.com/api/v2/integrations/okta/accounts/{account_id}https://api.datadoghq.com/api/v2/integrations/okta/accounts/{account_id}https://api.us3.datadoghq.com/api/v2/integrations/okta/accounts/{account_id}https://api.us5.datadoghq.com/api/v2/integrations/okta/accounts/{account_id}
Delete an Okta account.
This endpoint requires the manage_integrations
permission.
이름
유형
설명
account_id [required]
string
None
OK
Bad Request
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"
]
}
# Delete Okta account returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::OktaIntegrationAPI.new
api_instance.delete_okta_account("account_id")
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"