Skip to content

Add Integration Accounts v2 API public beta #3624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add Integration Accounts v2 API public beta #3624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
986 changes: 977 additions & 9 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

38 changes: 38 additions & 0 deletions examples/v2/integration-accounts/CreateIntegrationAccount.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Create an integration account returns "Created" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.create_integration_account".to_sym] = true
end
api_instance = DatadogAPIClient::V2::IntegrationAccountsAPI.new

body = DatadogAPIClient::V2::IntegrationAccountRequest.new({
data: DatadogAPIClient::V2::IntegrationAccountCreateData.new({
attributes: DatadogAPIClient::V2::IntegrationAccountAttributes.new({
integration: DatadogAPIClient::V2::TwilioIntegration.new({
interface: DatadogAPIClient::V2::TwilioInterface.new({
authentication: DatadogAPIClient::V2::TwilioBasicAuth.new({
api_key: "SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
api_key_token: "your-api-key-secret",
type: DatadogAPIClient::V2::TwilioBasicAuthType::BASIC,
}),
dataflows: [
DatadogAPIClient::V2::TwilioDataflow.new({
enabled: true,
id: DatadogAPIClient::V2::TwilioDataflowId::MESSAGES_LOGS,
}),
],
settings: DatadogAPIClient::V2::TwilioSettings.new({
account_sid: "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
censor_logs: true,
}),
type: DatadogAPIClient::V2::TwilioInterfaceType::TWILIO,
}),
type: DatadogAPIClient::V2::TwilioIntegrationType::TWILIO,
}),
name: "twilio-prod",
}),
type: DatadogAPIClient::V2::IntegrationAccountType::INTEGRATION_ACCOUNT,
}),
})
p api_instance.create_integration_account(IntegrationAccountIntegrationId::TWILIO, IntegrationAccountInterfaceId::TWILIO, body)
8 changes: 8 additions & 0 deletions examples/v2/integration-accounts/DeleteIntegrationAccount.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Delete an integration account returns "No Content" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.delete_integration_account".to_sym] = true
end
api_instance = DatadogAPIClient::V2::IntegrationAccountsAPI.new
api_instance.delete_integration_account(IntegrationAccountIntegrationId::TWILIO, IntegrationAccountInterfaceId::TWILIO, "account_id")
8 changes: 8 additions & 0 deletions examples/v2/integration-accounts/GetIntegrationAccount.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Get an integration account returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.get_integration_account".to_sym] = true
end
api_instance = DatadogAPIClient::V2::IntegrationAccountsAPI.new
p api_instance.get_integration_account(IntegrationAccountIntegrationId::TWILIO, IntegrationAccountInterfaceId::TWILIO, "account_id")
8 changes: 8 additions & 0 deletions examples/v2/integration-accounts/ListIntegrationAccounts.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# List integration accounts returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.list_integration_accounts".to_sym] = true
end
api_instance = DatadogAPIClient::V2::IntegrationAccountsAPI.new
p api_instance.list_integration_accounts(IntegrationAccountIntegrationId::TWILIO, IntegrationAccountInterfaceId::TWILIO)
38 changes: 38 additions & 0 deletions examples/v2/integration-accounts/UpdateIntegrationAccount.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Update an integration account returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.update_integration_account".to_sym] = true
end
api_instance = DatadogAPIClient::V2::IntegrationAccountsAPI.new

body = DatadogAPIClient::V2::IntegrationAccountUpdateRequest.new({
data: DatadogAPIClient::V2::IntegrationAccountUpdateData.new({
attributes: DatadogAPIClient::V2::IntegrationAccountUpdateAttributes.new({
integration: DatadogAPIClient::V2::TwilioIntegrationUpdate.new({
interface: DatadogAPIClient::V2::TwilioInterfaceUpdate.new({
authentication: DatadogAPIClient::V2::TwilioBasicAuth.new({
api_key: "SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
api_key_token: "your-api-key-secret",
type: DatadogAPIClient::V2::TwilioBasicAuthType::BASIC,
}),
dataflows: [
DatadogAPIClient::V2::TwilioDataflow.new({
enabled: true,
id: DatadogAPIClient::V2::TwilioDataflowId::MESSAGES_LOGS,
}),
],
settings: DatadogAPIClient::V2::TwilioSettingsUpdate.new({
account_sid: "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
censor_logs: true,
}),
type: DatadogAPIClient::V2::TwilioInterfaceType::TWILIO,
}),
type: DatadogAPIClient::V2::TwilioIntegrationType::TWILIO,
}),
name: "twilio-prod",
}),
type: DatadogAPIClient::V2::IntegrationAccountType::INTEGRATION_ACCOUNT,
}),
})
p api_instance.update_integration_account(IntegrationAccountIntegrationId::TWILIO, IntegrationAccountInterfaceId::TWILIO, "account_id", body)
25 changes: 25 additions & 0 deletions features/scenarios_model_mapping.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4100,6 +4100,31 @@
"account_id" => "String",
"body" => "OktaAccountUpdateRequest",
},
"v2.ListIntegrationAccounts" => {
"integration_id" => "IntegrationAccountIntegrationId",
"interface_id" => "IntegrationAccountInterfaceId",
},
"v2.CreateIntegrationAccount" => {
"integration_id" => "IntegrationAccountIntegrationId",
"interface_id" => "IntegrationAccountInterfaceId",
"body" => "IntegrationAccountRequest",
},
"v2.DeleteIntegrationAccount" => {
"integration_id" => "IntegrationAccountIntegrationId",
"interface_id" => "IntegrationAccountInterfaceId",
"account_id" => "String",
},
"v2.GetIntegrationAccount" => {
"integration_id" => "IntegrationAccountIntegrationId",
"interface_id" => "IntegrationAccountInterfaceId",
"account_id" => "String",
},
"v2.UpdateIntegrationAccount" => {
"integration_id" => "IntegrationAccountIntegrationId",
"interface_id" => "IntegrationAccountInterfaceId",
"account_id" => "String",
"body" => "IntegrationAccountUpdateRequest",
},
"v2.UpdateIPAllowlist" => {
"body" => "IPAllowlistUpdateRequest",
},
Expand Down
160 changes: 160 additions & 0 deletions features/v2/integration_accounts.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
@endpoint(integration-accounts) @endpoint(integration-accounts-v2)
Feature: Integration Accounts
Manage accounts for Datadog integrations served by the Account Management
Service (AMS). The account payload is strongly typed per integration and
interface.

Background:
Given a valid "apiKeyAuth" key in the system
And a valid "appKeyAuth" key in the system
And an instance of "IntegrationAccounts" API

@generated @skip @team:DataDog/saas-integrations
Scenario: Create an integration account returns "Bad Request" response
Given operation "CreateIntegrationAccount" enabled
And new "CreateIntegrationAccount" request
And request contains "integration_id" parameter from "REPLACE.ME"
And request contains "interface_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"integration": {"interface": {"authentication": {"api_key": "SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "api_key_token": "your-api-key-secret", "type": "basic"}, "dataflows": [{"enabled": true, "id": "twilio-messages-logs"}], "settings": {"account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "censor_logs": true}, "type": "twilio"}, "type": "twilio"}, "name": "twilio-prod"}, "type": "integration-account"}}
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/saas-integrations
Scenario: Create an integration account returns "Created" response
Given operation "CreateIntegrationAccount" enabled
And new "CreateIntegrationAccount" request
And request contains "integration_id" parameter from "REPLACE.ME"
And request contains "interface_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"integration": {"interface": {"authentication": {"api_key": "SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "api_key_token": "your-api-key-secret", "type": "basic"}, "dataflows": [{"enabled": true, "id": "twilio-messages-logs"}], "settings": {"account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "censor_logs": true}, "type": "twilio"}, "type": "twilio"}, "name": "twilio-prod"}, "type": "integration-account"}}
When the request is sent
Then the response status is 201 Created

@generated @skip @team:DataDog/saas-integrations
Scenario: Create an integration account returns "Not Found" response
Given operation "CreateIntegrationAccount" enabled
And new "CreateIntegrationAccount" request
And request contains "integration_id" parameter from "REPLACE.ME"
And request contains "interface_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"integration": {"interface": {"authentication": {"api_key": "SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "api_key_token": "your-api-key-secret", "type": "basic"}, "dataflows": [{"enabled": true, "id": "twilio-messages-logs"}], "settings": {"account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "censor_logs": true}, "type": "twilio"}, "type": "twilio"}, "name": "twilio-prod"}, "type": "integration-account"}}
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/saas-integrations
Scenario: Delete an integration account returns "Bad Request" response
Given operation "DeleteIntegrationAccount" enabled
And new "DeleteIntegrationAccount" request
And request contains "integration_id" parameter from "REPLACE.ME"
And request contains "interface_id" parameter from "REPLACE.ME"
And request contains "account_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/saas-integrations
Scenario: Delete an integration account returns "No Content" response
Given operation "DeleteIntegrationAccount" enabled
And new "DeleteIntegrationAccount" request
And request contains "integration_id" parameter from "REPLACE.ME"
And request contains "interface_id" parameter from "REPLACE.ME"
And request contains "account_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 204 No Content

@generated @skip @team:DataDog/saas-integrations
Scenario: Delete an integration account returns "Not Found" response
Given operation "DeleteIntegrationAccount" enabled
And new "DeleteIntegrationAccount" request
And request contains "integration_id" parameter from "REPLACE.ME"
And request contains "interface_id" parameter from "REPLACE.ME"
And request contains "account_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/saas-integrations
Scenario: Get an integration account returns "Bad Request" response
Given operation "GetIntegrationAccount" enabled
And new "GetIntegrationAccount" request
And request contains "integration_id" parameter from "REPLACE.ME"
And request contains "interface_id" parameter from "REPLACE.ME"
And request contains "account_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/saas-integrations
Scenario: Get an integration account returns "Not Found" response
Given operation "GetIntegrationAccount" enabled
And new "GetIntegrationAccount" request
And request contains "integration_id" parameter from "REPLACE.ME"
And request contains "interface_id" parameter from "REPLACE.ME"
And request contains "account_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/saas-integrations
Scenario: Get an integration account returns "OK" response
Given operation "GetIntegrationAccount" enabled
And new "GetIntegrationAccount" request
And request contains "integration_id" parameter from "REPLACE.ME"
And request contains "interface_id" parameter from "REPLACE.ME"
And request contains "account_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/saas-integrations
Scenario: List integration accounts returns "Bad Request" response
Given operation "ListIntegrationAccounts" enabled
And new "ListIntegrationAccounts" request
And request contains "integration_id" parameter from "REPLACE.ME"
And request contains "interface_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/saas-integrations
Scenario: List integration accounts returns "Not Found" response
Given operation "ListIntegrationAccounts" enabled
And new "ListIntegrationAccounts" request
And request contains "integration_id" parameter from "REPLACE.ME"
And request contains "interface_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/saas-integrations
Scenario: List integration accounts returns "OK" response
Given operation "ListIntegrationAccounts" enabled
And new "ListIntegrationAccounts" request
And request contains "integration_id" parameter from "REPLACE.ME"
And request contains "interface_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/saas-integrations
Scenario: Update an integration account returns "Bad Request" response
Given operation "UpdateIntegrationAccount" enabled
And new "UpdateIntegrationAccount" request
And request contains "integration_id" parameter from "REPLACE.ME"
And request contains "interface_id" parameter from "REPLACE.ME"
And request contains "account_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"integration": {"interface": {"authentication": {"api_key": "SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "api_key_token": "your-api-key-secret", "type": "basic"}, "dataflows": [{"enabled": true, "id": "twilio-messages-logs"}], "settings": {"account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "censor_logs": true}, "type": "twilio"}, "type": "twilio"}, "name": "twilio-prod"}, "type": "integration-account"}}
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/saas-integrations
Scenario: Update an integration account returns "Not Found" response
Given operation "UpdateIntegrationAccount" enabled
And new "UpdateIntegrationAccount" request
And request contains "integration_id" parameter from "REPLACE.ME"
And request contains "interface_id" parameter from "REPLACE.ME"
And request contains "account_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"integration": {"interface": {"authentication": {"api_key": "SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "api_key_token": "your-api-key-secret", "type": "basic"}, "dataflows": [{"enabled": true, "id": "twilio-messages-logs"}], "settings": {"account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "censor_logs": true}, "type": "twilio"}, "type": "twilio"}, "name": "twilio-prod"}, "type": "integration-account"}}
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/saas-integrations
Scenario: Update an integration account returns "OK" response
Given operation "UpdateIntegrationAccount" enabled
And new "UpdateIntegrationAccount" request
And request contains "integration_id" parameter from "REPLACE.ME"
And request contains "interface_id" parameter from "REPLACE.ME"
And request contains "account_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"integration": {"interface": {"authentication": {"api_key": "SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "api_key_token": "your-api-key-secret", "type": "basic"}, "dataflows": [{"enabled": true, "id": "twilio-messages-logs"}], "settings": {"account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "censor_logs": true}, "type": "twilio"}, "type": "twilio"}, "name": "twilio-prod"}, "type": "integration-account"}}
When the request is sent
Then the response status is 200 OK
45 changes: 45 additions & 0 deletions features/v2/undo.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4349,6 +4349,51 @@
"type": "idempotent"
}
},
"ListIntegrationAccounts": {
"tag": "Integration Accounts",
"undo": {
"type": "safe"
}
},
"CreateIntegrationAccount": {
"tag": "Integration Accounts",
"undo": {
"operationId": "DeleteIntegrationAccount",
"parameters": [
{
"name": "integration_id",
"source": "integration_id"
},
{
"name": "interface_id",
"source": "interface_id"
},
{
"name": "account_id",
"source": "data.id"
}
],
"type": "unsafe"
}
},
"DeleteIntegrationAccount": {
"tag": "Integration Accounts",
"undo": {
"type": "idempotent"
}
},
"GetIntegrationAccount": {
"tag": "Integration Accounts",
"undo": {
"type": "safe"
}
},
"UpdateIntegrationAccount": {
"tag": "Integration Accounts",
"undo": {
"type": "idempotent"
}
},
"GetIPAllowlist": {
"tag": "IP Allowlist",
"undo": {
Expand Down
7 changes: 5 additions & 2 deletions lib/datadog_api_client/configuration.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -432,8 +432,6 @@ def initialize
"v2.get_all_datasets": false,
"v2.get_dataset": false,
"v2.update_dataset": false,
"v2.execute_ddsql_tabular_query": false,
"v2.fetch_ddsql_tabular_query": false,
"v2.cancel_data_deletion_request": false,
"v2.create_data_deletion_request": false,
"v2.get_data_deletion_requests": false,
Expand Down Expand Up @@ -543,6 +541,11 @@ def initialize
"v2.update_jira_issue_template": false,
"v2.create_tenancy_config": false,
"v2.get_tenancy_configs": false,
"v2.create_integration_account": false,
"v2.delete_integration_account": false,
"v2.get_integration_account": false,
"v2.list_integration_accounts": false,
"v2.update_integration_account": false,
"v2.add_role_to_restriction_query": false,
"v2.create_restriction_query": false,
"v2.delete_restriction_query": false,
Expand Down
Loading
Loading