Document scope management and update Mobile and Third-Party Access#35705
Document scope management and update Mobile and Third-Party Access#35705nirrattner wants to merge 6 commits intomasterfrom
Conversation
Preview links (active after the
|
|
|
||
| ### Enable | ||
|
|
||
| Enabled OAuth applications allow users with necessary permissions to authorize access on their behalf. OAuth applications include the Datadog Mobile App and MCP (Model Context Protocol) OAuth clients registered through Dynamic Client Registration. |
There was a problem hiding this comment.
There's reference to MCP clients here - would it be premature to release these docs before we migrate away from the singleton proxy being used now?
There was a problem hiding this comment.
Yeah good point, updating this
| url: account_management/org_settings/oauth_apps | ||
| - name: Mobile and Third-Party Access | ||
| identifier: account_management_org_settings_mobile_third_party_access | ||
| url: account_management/org_settings/mobile_third_party_access |
There was a problem hiding this comment.
Should we be wary of updating this URL? It could be referenced in other docs
There was a problem hiding this comment.
Good catch, just updated the references within the documentation and also introduced an alias so that the old URL will redirect to the new page for any references outside of our control
iadjivon
left a comment
There was a problem hiding this comment.
Hi there, thanks for this PR. I've added some comments here. Please let me know once this is ready for re-review.
| - link: "/account_management/org_settings/oauth_apps" | ||
| - link: "/account_management/org_settings/mobile_third_party_access" | ||
| tag: "Documentation" | ||
| text: "OAuth Apps" |
There was a problem hiding this comment.
Should this be changed to Mobile Third Party Access?
|
|
||
| The allowed scopes for an application can be modified by enabling Application Scope Management. Adding or removing a scope will affect the access for this application for all users in your organization. When a scope is disabled, all existing authorizations in your organization for that application that have the scope granted will be revoked. | ||
|
|
||
| Currently, only MCP applications have support for Application Scope Management. |
There was a problem hiding this comment.
| Currently, only MCP applications have support for Application Scope Management. | |
| Only MCP applications support Application Scope Management. |
|
|
||
| ### Application Scope Management | ||
|
|
||
| The allowed scopes for an application can be modified by enabling Application Scope Management. Adding or removing a scope will affect the access for this application for all users in your organization. When a scope is disabled, all existing authorizations in your organization for that application that have the scope granted will be revoked. |
There was a problem hiding this comment.
| The allowed scopes for an application can be modified by enabling Application Scope Management. Adding or removing a scope will affect the access for this application for all users in your organization. When a scope is disabled, all existing authorizations in your organization for that application that have the scope granted will be revoked. | |
| Enable Application Scope Management to modify the allowed scopes for an application. Adding or removing a scope affects access to this application for all users in your organization. Disabling a scope revokes all existing authorizations in your organization for that application. |
I modified this section to be in the active voice. Please let me know if this keeps the meaning.
There was a problem hiding this comment.
Thanks! It mostly keeps the meaning, but there is some nuance that is lost in the last sentence. Only a subset of existing authorizations may be revoked, whereas the last sentence now indicates that all existing authorizations will be revoked. Specifically it is only the existing authorizations that would conflict with the new allowed scopes configuration that would be revoked. It's not clear to me if it's valuable to communicate that distinction in the documentation here?
There was a problem hiding this comment.
That's a very fair point and important distinction. How about:
Disabling a scope revokes any existing authorization for that application where the scope was granted.
OR
Disabling a scope revokes any existing authorizations for applications that have the scope granted.
Or a focus on the user if applicable:
Disabling a scope revokes access for any user in your organization who was granted that scope for the application.
There was a problem hiding this comment.
To me, this one seems cleanest:
Disabling a scope revokes any existing authorizations for applications that have the scope granted.
I can update that now, thanks!
| 1. In the **Application Scope Management** view, use the **Allowed** checkbox for each scope to control whether the application can be granted that scope. | ||
|
|
||
| {{< img src="account_management/mobile_third_party_access/scope-restrictions-enable.png" alt="Application Scope Management view with Enable and Restore to Full Access buttons" style="width:100%;">}} | ||
|
|
||
| 2. After making your changes, click **Enable** to save the scope configuration. |
There was a problem hiding this comment.
| 1. In the **Application Scope Management** view, use the **Allowed** checkbox for each scope to control whether the application can be granted that scope. | |
| {{< img src="account_management/mobile_third_party_access/scope-restrictions-enable.png" alt="Application Scope Management view with Enable and Restore to Full Access buttons" style="width:100%;">}} | |
| 2. After making your changes, click **Enable** to save the scope configuration. | |
| 1. On the **Mobile and Third-Party Access page**, click an application to open its detail view. | |
| 2. Select the **Scopes** tab and use the **Allowed** checkbox for each scope to control whether to grant he application that scope. | |
| 3. Click Enable to save the scope configuration. | |
| {{< img src="account_management/mobile_third_party_access/scope-restrictions-enable.png" alt="Application Scope Management view with Enable and Restore to Full Access buttons" style="width:100%;">}} | |
I'd recommend these steps. Let me know what you think.
| [4]: /account_management/rbac/permissions/ | ||
| [5]: https://app.datadoghq.com/organization-settings/oauth-applications |
There was a problem hiding this comment.
Links [4] and [5] do not seem to be used in this file. Link [5] also still uses oauth-applications.
I'd recommend removing these links if they are not needed.
| ### Mobile and Third-Party Access | ||
|
|
||
| The [**OAuth Apps**][15] page allows you to view or manage OAuth applications in your organization. | ||
| The [**Mobile and Third-Party Access**][15] page allows you to view or manage Datadog Mobile and Third-Party applications in your organization. |
There was a problem hiding this comment.
| The [**Mobile and Third-Party Access**][15] page allows you to view or manage Datadog Mobile and Third-Party applications in your organization. | |
| The [**Mobile and Third-Party Access**][15] page allows you to view and manage mobile and third-party applications in your organization. |
There was a problem hiding this comment.
I don't think this is used in the page. I'd recommend removing it so that is is not merged.
|
|
||
| Disabling OAuth access for an application revokes access to this application for all users in your organization. While the application remains installed, users are no longer able to use the application and are prompted with an error if they attempt to authorize it. | ||
|
|
||
| There are two ways to disable an application from the Mobile and Third-Party Access page: |
There was a problem hiding this comment.
| There are two ways to disable an application from the Mobile and Third-Party Access page: | |
| To disable an application from the Mobile and Third-Party Access page: |
Quick edit to the legacy content.
What does this PR do? What is the motivation?
This PR makes a few changes:
org_managementtoorg_authorized_apps_readandorg_authorized_apps_writeMerge instructions
Merge readiness:
AI assistance
Used Claude Code for initial draft.