Create an OAuth client for the Dynatrace Monaco CLI
This guide shows you how to create an OAuth client for use with Dynatrace Configuration as Code via Monaco.
Create an OAuth client
-
Go to Account Management.
-
Select Identity & access management > API OAuth clients.
-
Select Create client.
-
Enter the email address of the user who owns the client.
-
Enter a description of the new client.
-
Select the required scopes.
Each available type of Platform configuration requires specific OAuth scopes. For details, see Configuration types and access permissions.
Generally, OAuth client credentials for the Dynatrace Monaco CLI should have these scopes:
Purpose Scopes Access Platform metadata like Classic URLs and version information app-engine:apps:runView and create settings objects settings:objects:read,settings:objects:writeView settings schemas settings:schemas:readView and create workflows automation:workflows:read,automation:workflows:write,automation:calendars:read,automation:calendars:write,automation:rules:read,automation:rules:writeAccess all workflows1 automation:workflows:adminView and create Grail buckets storage:bucket-definitions:read,storage:bucket-definitions:write1To use the
automation:workflows:adminscope, you need to create a custom policy granting that scope, bind a group to it, and assign your user to that group in Account Management before creating the OAuth client. For detailed information on managing policies, see Manage IAM policies. -
Select Create client.
-
Copy the generated client ID and secret and store them in a safe place.
You can only access your client secret once upon creation. You can't reveal it afterward.
Ensure service user permissions
In addition to the scopes available to the OAuth client, permissions can be further limited via policies applied to the user's groups.
For details on how permissions can be controlled, see Manage user permissions with IAM policies.
To ensure that your OAuth client works as intended, verify that the service user's groups grant the same scopes as the OAuth client you have created for all environments you want to use it with.
Use your OAuth client
Follow the instructions for your operating system or CI/CD tool on how to make the client ID and secret available as environment variables.
- Reference the environment variables you have created in the oAuth section of your manifest file.
The Dynatrace Monaco CLI will request OAuth access tokens using your client credentials to make authenticated API calls.