Skip to content

Release OTR mode for application key #29541

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.

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions content/en/account_management/api-app-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,18 @@ API keys are unique to your organization. An [API key][1] is required by the Dat

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to mention what behavior child-orgs of orgs in otr mode could have?

[Application keys][2], in conjunction with your organization's API key, give users access to Datadog's programmatic API. Application keys are associated with the user account that created them and by default have the permissions of the user who created them.

### One-Time Read Mode

One-Time Read (OTR) mode is a security feature that limits the visibility of application key secrets to creation time only. When enabled:

- Application key secrets are only visible once, immediately after creation
- The raw values cannot be retrieved later via the UI or API
- You must securely store the key value when it is first displayed

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we mention the v1 API change here too?

You can enable OTR mode in [Organization Settings][18].

**Note**: For organizations created after [DATE TBD], OTR mode is enabled by default and cannot be disabled.

### Scopes

To better protect and secure your applications, you can specify authorization scopes for your application keys to define more granular permissions and minimize the access that applications have to your Datadog data. This gives you fine-grained access control over your applications and minimizes security vulnerabilities by limiting extraneous access. For example, an application that only reads dashboards does not need admin rights to manage users or delete any of your organization's data.
Expand Down Expand Up @@ -142,3 +154,4 @@ Need help? Contact [Datadog support][16].
[15]: /api/latest/service-accounts/
[16]: /help/
[17]: /account_management/org_settings/service_accounts/
[18]: https://app.datadoghq.com/organization-settings/

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we link directly to the application keys page?

https://app.datadoghq.com/organization-settings/application-keys

13 changes: 13 additions & 0 deletions content/en/account_management/org_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,19 @@ This section allows you to view, copy, and revoke any API key in the list. Your

You can filter application keys by name, ID, or owner, or click the **Only My Keys** toggle to only view application keys you own. Read the [Application keys documentation][8] for more information on adding and removing keys.

#### One-Time Read Mode

If you have the `org_management` permission, you can enable One-Time Read (OTR) mode in Organization > Application Keys settings. When enabled:

- All application key secrets in your organization become one-time read only
- Key secrets are only visible immediately after creation
- v1 Application Key APIs become unavailable

**Note**:
- For organizations created after [DATE TBD], OTR mode is enabled by default and cannot be disabled
- For existing organizations, once enabled, you have 3 months to disable the feature if needed. Each enablement starts a new 3-month period. After this period expires, OTR mode becomes permanent
- Contact [Datadog Support][16] for early enforcement

### Roles

To learn about default and custom roles in Datadog, read the [Role Based Access Control documentation][9].
Expand Down
Loading