Skip to content

Update end user credential management API scopes#5947

Open
NipuniBhagya wants to merge 2 commits intowso2:masterfrom
NipuniBhagya:credential-api-master
Open

Update end user credential management API scopes#5947
NipuniBhagya wants to merge 2 commits intowso2:masterfrom
NipuniBhagya:credential-api-master

Conversation

@NipuniBhagya
Copy link
Copy Markdown
Contributor

@NipuniBhagya NipuniBhagya commented Mar 8, 2026

Purpose

This pull request updates the documentation for the End-User Credential Management REST API across multiple locations to reflect new scope (permission) names for listing and deleting user credentials. The changes ensure consistency and accuracy in scope references throughout the API docs.

Permission scope updates:

  • Updated all references of the scopes from internal_user_mgt_view and internal_user_mgt_delete to internal_user_credential_mgt_view and internal_user_credential_mgt_delete in the API descriptions, endpoint documentation, and OAuth2 scopes. This affects both organization-level and general REST API documentation for Asgardeo and Identity Server. [1] [2] [3] [4]

These changes help prevent confusion for API consumers by ensuring the required scopes are correctly documented.

Related PRs

Test environment

Security checks

Summary by CodeRabbit

  • Documentation
    • Refined security scope naming in credential management API documentation. Authorization requirements for credential list and delete operations are now reflected with credential-specific scopes instead of general user management terminology, improving clarity across Asgardeo and Identity Server API specifications.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 8, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a07cfbae-4026-4af5-bc17-3be64ffdec72

📥 Commits

Reviewing files that changed from the base of the PR and between 3f332c6 and c732a80.

📒 Files selected for processing (4)
  • en/asgardeo/docs/apis/organization-apis/restapis/end-user-credential-management.yaml
  • en/asgardeo/docs/apis/restapis/end-user-credential-management.yaml
  • en/identity-server/next/docs/apis/organization-apis/restapis/end-user-credential-management.yaml
  • en/identity-server/next/docs/apis/restapis/end-user-credential-management.yaml

Walkthrough

This PR updates OAuth2 scope names across four credential management API documentation files, renaming authentication scopes from internal_user_mgt_* to internal_user_credential_mgt_* to better reflect the credential-specific nature of the API endpoints and their documentation.

Changes

Cohort / File(s) Summary
OAuth2 Credential Scope Rename
en/asgardeo/docs/apis/organization-apis/restapis/end-user-credential-management.yaml, en/asgardeo/docs/apis/restapis/end-user-credential-management.yaml, en/identity-server/next/docs/apis/organization-apis/restapis/end-user-credential-management.yaml, en/identity-server/next/docs/apis/restapis/end-user-credential-management.yaml
Updated OAuth2 read/delete scopes from internal_user_mgt_view/internal_user_mgt_delete to internal_user_credential_mgt_view/internal_user_credential_mgt_delete in API descriptions, endpoint operation descriptions, and security scheme definitions.

Estimated Code Review Effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Scopes renamed with care so true,
From user\_mgt to credential\_mgt through and through,
Four files aligned in harmony,
Documentation now sings with clarity!
OAuth2 flows dance with updated names. ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically summarizes the main change: updating OAuth2 scope names in the credential management API documentation.
Description check ✅ Passed The description is largely complete with the Purpose section filled out, but the Related PRs and Test environment sections are empty, and security checks are unchecked.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant