wso2 / wso2/docs-apim

Configure IS-7.x as Third party KM for APIM - Official Documentation Improvement

Open
#10,362 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type/Improvement
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

Description

Hi Team,

If someone refers to this[1] and tries to configure IS as the Key Manager while using the /keymanager-operations/user-info endpoint, they will not know that an additional access control configuration is required. We should clearly mention in the documentation that if /keymanager-operations/user-info is used as the user-info endpoint, the following configuration is not required in IS:

[[resource.access_control]]
context="(.*)/scim2/Me"
secure=true
http_method="GET"
cross_tenant=true
permissions=[]
scopes=[]

However, if any other access controls are applied in IS, the following access control must also be added in the IS deployment.toml:

[[resource.access_control]]
context = "(.*)/keymanager-operations/user-info/claims/generate"
secure = true
http_method = "POST"
permissions = "/permission/admin/manage/identity/usermgt/list"
scopes = "internal_user_mgt_list"

[1]https://apim.docs.wso2.com/en/4.4.0/administer/key-managers/configure-wso2is7-connector/#configure-wso2-is-7x-as-a-key-manager:~:text=Add%20following%20configurations%20in%20the%20%3CIS7_HOME%3E/repository/conf/deployment.toml%20file.

Thanks and Regards,
Sujit

Suggested Improvement

It will be good if we update the APIM official doc with this.

Version(s)

4.x

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked APIM documentation page, “Configure WSO2 IS 7.x as a Key Manager,” and review its deployment.toml configuration section. Update the page to explain when the /keymanager-operations/user-info access control is required and when the /scim2/Me configuration is not required. Done means both conditions and the supplied configuration are clearly documented.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.