Skip to content

Add OpenAPI spec for End User Device Monitoring endpoints #3392

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 OpenAPI spec for End User Device Monitoring endpoints #3392

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
1,224 changes: 1,224 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions ...tes/features/v2/end_user_device_monitoring/Get-a-device-returns-Not-Found-response.frozen
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2026-05-26T22:33:26.244Z
20 changes: 20 additions & 0 deletions cassettes/features/v2/end_user_device_monitoring/Get-a-device-returns-Not-Found-response.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions ...v2/end_user_device_monitoring/Get-all-device-issue-definitions-returns-OK-response.frozen
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2026-05-26T22:33:27.655Z
30 changes: 30 additions & 0 deletions ...es/v2/end_user_device_monitoring/Get-all-device-issue-definitions-returns-OK-response.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions cassettes/features/v2/end_user_device_monitoring/Get-all-devices-returns-OK-response.frozen
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2026-05-26T22:33:27.236Z
37 changes: 37 additions & 0 deletions cassettes/features/v2/end_user_device_monitoring/Get-all-devices-returns-OK-response.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions ..._user_device_monitoring/Get-device-counts-grouped-by-attribute-returns-OK-response.frozen
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2026-05-26T22:33:27.588Z
20 changes: 20 additions & 0 deletions ...end_user_device_monitoring/Get-device-counts-grouped-by-attribute-returns-OK-response.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions ...ttes/features/v2/end_user_device_monitoring/Get-overview-tiles-returns-OK-response.frozen
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2026-05-26T22:33:27.698Z
20 changes: 20 additions & 0 deletions cassettes/features/v2/end_user_device_monitoring/Get-overview-tiles-returns-OK-response.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions examples/v2/end-user-device-monitoring/GetEUDMDevice.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Get a device returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::EndUserDeviceMonitoringAPI.new
p api_instance.get_eudm_device("device_id")
5 changes: 5 additions & 0 deletions examples/v2/end-user-device-monitoring/GetEUDMDevices.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Get all devices returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::EndUserDeviceMonitoringAPI.new
p api_instance.get_eudm_devices()
5 changes: 5 additions & 0 deletions examples/v2/end-user-device-monitoring/GetEUDMGraph.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Get device counts grouped by attribute returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::EndUserDeviceMonitoringAPI.new
p api_instance.get_eudm_graph("by")
5 changes: 5 additions & 0 deletions examples/v2/end-user-device-monitoring/GetEUDMIssues.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Get all device issue definitions returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::EndUserDeviceMonitoringAPI.new
p api_instance.get_eudm_issues()
5 changes: 5 additions & 0 deletions examples/v2/end-user-device-monitoring/GetEUDMOverview.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Get overview tiles returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::EndUserDeviceMonitoringAPI.new
p api_instance.get_eudm_overview()
8 changes: 8 additions & 0 deletions examples/v2/oauth2-client-public/DeleteScopesRestriction.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Delete an OAuth2 client scopes restriction returns "No Content" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.delete_scopes_restriction".to_sym] = true
end
api_instance = DatadogAPIClient::V2::OAuth2ClientPublicAPI.new
api_instance.delete_scopes_restriction("fafa8e1c-36a5-11f0-a83d-da7ad0900001")
8 changes: 8 additions & 0 deletions examples/v2/oauth2-client-public/GetScopesRestriction.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Get an OAuth2 client scopes restriction returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.get_scopes_restriction".to_sym] = true
end
api_instance = DatadogAPIClient::V2::OAuth2ClientPublicAPI.new
p api_instance.get_scopes_restriction("fafa8e1c-36a5-11f0-a83d-da7ad0900001")
29 changes: 29 additions & 0 deletions examples/v2/oauth2-client-public/RegisterOAuthClient.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Register an OAuth2 client returns "Created" response

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

body = DatadogAPIClient::V2::OAuthClientRegistrationRequest.new({
client_name: "Example MCP Client",
client_uri: "https://example.com",
grant_types: [
DatadogAPIClient::V2::OAuthClientRegistrationGrantType::AUTHORIZATION_CODE,
DatadogAPIClient::V2::OAuthClientRegistrationGrantType::REFRESH_TOKEN,
],
jwks_uri: "https://example.com/.well-known/jwks.json",
logo_uri: "https://example.com/logo.png",
policy_uri: "https://example.com/privacy",
redirect_uris: [
"https://example.com/oauth/callback",
],
response_types: [
DatadogAPIClient::V2::OAuthClientRegistrationResponseType::CODE,
],
scope: "openid profile",
token_endpoint_auth_method: "none",
tos_uri: "https://example.com/tos",
})
p api_instance.register_o_auth_client(body)
24 changes: 24 additions & 0 deletions examples/v2/oauth2-client-public/UpsertScopesRestriction.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Upsert an OAuth2 client scopes restriction returns "OK" response

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

body = DatadogAPIClient::V2::UpsertOAuthScopesRestrictionRequest.new({
data: DatadogAPIClient::V2::UpsertOAuthScopesRestrictionData.new({
attributes: DatadogAPIClient::V2::UpsertOAuthScopesRestrictionDataAttributes.new({
oidc_scopes: [
DatadogAPIClient::V2::OAuthOidcScope::OPENID,
DatadogAPIClient::V2::OAuthOidcScope::EMAIL,
],
permission_scopes: [
"dashboards_read",
"metrics_read",
],
}),
type: DatadogAPIClient::V2::UpsertOAuthScopesRestrictionType::UPSERT_SCOPES_RESTRICTION,
}),
})
p api_instance.upsert_scopes_restriction("fafa8e1c-36a5-11f0-a83d-da7ad0900001", body)
19 changes: 19 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 @@ -2942,6 +2942,12 @@
"issue_id" => "String",
"body" => "IssueUpdateStateRequest",
},
"v2.GetEUDMDevice" => {
"device_id" => "String",
},
"v2.GetEUDMGraph" => {
"by" => "String",
},
"v2.ListEvents" => {
"filter_query" => "String",
"filter_from" => "String",
Expand Down Expand Up @@ -3881,6 +3887,19 @@
"tags" => "String",
"limit" => "Integer",
},
"v2.DeleteScopesRestriction" => {
"client_uuid" => "UUID",
},
"v2.GetScopesRestriction" => {
"client_uuid" => "UUID",
},
"v2.UpsertScopesRestriction" => {
"client_uuid" => "UUID",
"body" => "UpsertOAuthScopesRestrictionRequest",
},
"v2.RegisterOAuthClient" => {
"body" => "OAuthClientRegistrationRequest",
},
"v2.ListPipelines" => {
"page_size" => "Integer",
"page_number" => "Integer",
Expand Down
49 changes: 49 additions & 0 deletions features/v2/end_user_device_monitoring.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
@endpoint(end-user-device-monitoring) @endpoint(end-user-device-monitoring-v2)
Feature: End User Device Monitoring
Inspect devices reported by the Datadog Agent on end-user laptops,
desktops, and mobile devices, including their health, hardware, and
connectivity attributes.

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

@generated @skip @team:DataDog/windows-products
Scenario: Get a device returns "Not Found" response
Given new "GetEUDMDevice" request
And request contains "device_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/windows-products
Scenario: Get a device returns "OK" response
Given new "GetEUDMDevice" request
And request contains "device_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/windows-products
Scenario: Get all device issue definitions returns "OK" response
Given new "GetEUDMIssues" request
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/windows-products
Scenario: Get all devices returns "OK" response
Given new "GetEUDMDevices" request
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/windows-products
Scenario: Get device counts grouped by attribute returns "OK" response
Given new "GetEUDMGraph" request
And request contains "by" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/windows-products
Scenario: Get overview tiles returns "OK" response
Given new "GetEUDMOverview" request
When the request is sent
Then the response status is 200 OK
42 changes: 42 additions & 0 deletions features/v2/eudm.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
@endpoint(eudm) @endpoint(eudm-v2)
Feature: End User Device Monitoring
Inspect devices reported by the Datadog Agent on end-user laptops, desktops,
and mobile devices, including their health, hardware, and connectivity
attributes.

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

@team:DataDog/windows-products
Scenario: Get a device returns "Not Found" response
Given new "GetEUDMDevice" request
And request contains "device_id" parameter with value "not_found"
When the request is sent
Then the response status is 404 Not Found

@team:DataDog/windows-products
Scenario: Get all devices returns "OK" response
Given new "GetEUDMDevices" request
When the request is sent
Then the response status is 200 OK

@team:DataDog/windows-products
Scenario: Get device counts grouped by attribute returns "OK" response
Given new "GetEUDMGraph" request
And request contains "by" parameter with value "os"
When the request is sent
Then the response status is 200 OK

@team:DataDog/windows-products
Scenario: Get all device issue definitions returns "OK" response
Given new "GetEUDMIssues" request
When the request is sent
Then the response status is 200 OK

@team:DataDog/windows-products
Scenario: Get overview tiles returns "OK" response
Given new "GetEUDMOverview" request
When the request is sent
Then the response status is 200 OK
Loading
Loading