Skip to content

Add end-user credential management API resource #7633

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add end-user credential management API resource #7633

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
20 changes: 20 additions & 0 deletions ...wso2.carbon.identity.api.resource.mgt.server.feature/resources/system-api-resource.xml.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2163,4 +2163,24 @@
description="Delete workflow instance"/>
</Scopes>
</APIResource>
<APIResource name="Credential Management API" identifier="/api/server/v1/users/(.*)/credentials"
requiresAuthorization="true"
description="API representation of the Credential Management API" type="TENANT">
Comment on lines +2167 to +2168
Copy link

Copilot AI Nov 25, 2025

Choose a reason for hiding this comment

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

Inconsistent indentation. The requiresAuthorization attribute should align with the name attribute on the previous line, similar to other APIResource elements in this file (e.g., lines 2087, 2101, 2115).

The line currently has excessive spacing (29 spaces) instead of the standard 17 spaces used throughout the file.

Suggested change
requiresAuthorization="true"
description="API representation of the Credential Management API" type="TENANT">
requiresAuthorization="true"
description="API representation of the Credential Management API" type="TENANT">

Copilot uses AI. Check for mistakes.
<Scopes>
<Scope displayName="View Credential" name="internal_user_mgt_view"
description="View credentials of users in the organization"/>
<Scope displayName="Delete Credential" name="internal_user_mgt_delete"
description="Delete credentials of users in the organization"/>
Comment on lines +2171 to +2173
Copy link

Copilot AI Nov 25, 2025

Choose a reason for hiding this comment

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

The scope description should follow the established pattern for TENANT type APIs. Based on similar APIs in this file (e.g., SCIM2 Users API at lines 772, 774, 776, 778, 780), TENANT type scope descriptions use "in the organization (root)" instead of just "in the organization". This helps distinguish between tenant-level and organization-level scopes.

Suggested: description="View credentials of users in the organization (root)"

Suggested change
description="View credentials of users in the organization"/>
<Scope displayName="Delete Credential" name="internal_user_mgt_delete"
description="Delete credentials of users in the organization"/>
description="View credentials of users in the organization (root)"/>
<Scope displayName="Delete Credential" name="internal_user_mgt_delete"
description="Delete credentials of users in the organization (root)"/>

Copilot uses AI. Check for mistakes.
Comment on lines +2171 to +2173
Copy link

Copilot AI Nov 25, 2025

Choose a reason for hiding this comment

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

The scope description should follow the established pattern for TENANT type APIs. Based on similar APIs in this file (e.g., SCIM2 Users API at lines 776, 778, 780), TENANT type scope descriptions use "in the organization (root)" instead of just "in the organization". This helps distinguish between tenant-level and organization-level scopes.

Suggested: description="Delete credentials of users in the organization (root)"

Suggested change
description="View credentials of users in the organization"/>
<Scope displayName="Delete Credential" name="internal_user_mgt_delete"
description="Delete credentials of users in the organization"/>
description="View credentials of users in the organization (root)"/>
<Scope displayName="Delete Credential" name="internal_user_mgt_delete"
description="Delete credentials of users in the organization (root)"/>

Copilot uses AI. Check for mistakes.
</Scopes>
</APIResource>
<APIResource name="Credential Management API" identifier="/o/api/server/v1/users/(.*)/credentials"
requiresAuthorization="true"
description="API representation of the Credential Management API" type="ORGANIZATION">
<Scopes>
<Scope displayName="View Credential" name="internal_org_user_mgt_view"
description="View credentials of users in the organization"/>
<Scope displayName="Delete Credential" name="internal_org_user_mgt_delete"
description="Delete credentials of users in the organization"/>
</Scopes>
</APIResource>
</APIResources>
16 changes: 16 additions & 0 deletions .../org.wso2.carbon.identity.core.server.feature/resources/resource-access-control-v2.xml.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2061,6 +2061,22 @@
<Scopes>internal_workflow_instance_delete</Scopes>
</Resource>

<!-- [Organization] End User Credential Management API -->
<Resource context="(.*)/o/api/server/v1/users/(.*)/credentials" secured="true" http-method="GET">
<Scopes>internal_org_user_mgt_view</Scopes>
</Resource>
<Resource context="(.*)/o/api/server/v1/users/(.*)/credentials/(.*)" secured="true" http-method="DELETE">
<Scopes>internal_org_user_mgt_delete</Scopes>
</Resource>

<!-- End User Credential Management API -->
<Resource context="(.*)/api/server/v1/users/(.*)/credentials" secured="true" http-method="GET">
<Scopes>internal_user_mgt_view</Scopes>
</Resource>
<Resource context="(.*)/api/server/v1/users/(.*)/credentials/(.*)" secured="true" http-method="DELETE">
<Scopes>internal_user_mgt_delete</Scopes>
</Resource>

<!-- Wild Cards; These scopes are not avaiable in the V2 runtime, therefore any other API will be blocked. -->
<Resource context="(.*)/api/server/v1/(?!(tenants|channel-verified-tenants))(.*)" secured="true" http-method="all">
<Scopes>internal_identity_mgt_view</Scopes>
Expand Down