Skip to content
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

Documentation Enhancements Admin Rest API Group to Client Role Mappings #29266

Closed
1 of 2 tasks
sprehn-ero opened this issue May 3, 2024 · 4 comments
Closed
1 of 2 tasks

Comments

@sprehn-ero
Copy link
Contributor

Before reporting an issue

  • I have read and understood the above terms for submitting issues, and I understand that my issue may be closed without action if I do not follow them.

Area

docs

Describe the bug

Documentation on admin rest api
https://www.keycloak.org/docs-api/latest/rest-api/index.html states in section

POST /admin/realms/{realm}/groups/{group-id}/role-mappings/clients/{client}
that body parameter should be of type RoleRepresentation, when it really should be List of [RoleRepresentation]

Please also review the description of endpoints group/{group-id}/role-mapping/{client}
The mention that this maps the role to a user, when it really is a mapping for a group.

I also suggest to rename the palceholder {client} to {client-id} and add in the description, which id is expected (the id and not clientId.

Version

latest

Regression

  • The issue is a regression

Expected behavior

see bug description

Actual behavior

see bug description

How to Reproduce?

see bug description

Anything else?

No response

@sprehn-ero sprehn-ero added kind/bug Categorizes a PR related to a bug status/triage labels May 3, 2024
@sguilhen
Copy link
Contributor

sguilhen commented May 6, 2024

Verified, documentation needs to be updated in these cases. Contributions are welcome!

@keycloak-github-bot
Copy link

Due to the amount of issues reported by the community we are not able to prioritise resolving this issue at the moment.

If you are affected by this issue, upvote it by adding a 👍 to the description. We would also welcome a contribution to fix the issue.

@sprehn-ero
Copy link
Contributor Author

Suggested Fix PR #29344

@sguilhen
Copy link
Contributor

sguilhen commented May 7, 2024

Thanks, @sprehn-ero !

@sguilhen sguilhen self-assigned this May 9, 2024
sprehn-ero added a commit to sprehn-ero/keycloak that referenced this issue May 13, 2024
Closes keycloak#29266

Signed-off-by: Sebastian Prehn <sebastian.prehn@ero.eu>
@ahus1 ahus1 closed this as completed in b5d0154 May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants