docs(orchestrator): add documentation for using the auth requester widget#976
Merged
Conversation
mareklibra
requested changes
Jun 16, 2025
| | ------------------------------- | ------------------ | -------- | --------------------------------------------------------------------- | | ||
| | `ui:widget` | string | Yes | Must be `"AuthRequester"` | | ||
| | `ui:props.authTokenDescriptors` | array of objects | Yes | List of token requirements | | ||
| | — `provider` | string | Yes | One of `github`, `gitlab`, `microsoft`, etc. | |
Member
There was a problem hiding this comment.
I would remove the etc here but kept maintaining that list when we add new providers
| ## Best Practices | ||
|
|
||
| - Use this field to declare token requirements up front. | ||
| - Only one `AuthRequester` field is needed per form, even for multiple providers. |
Member
There was a problem hiding this comment.
Let's add explanation what happens if there are multiple instances of the widget. Or rephrase.
Contributor
Author
There was a problem hiding this comment.
If there are multiple, only the last one would apply. Perhaps we should have an error message for this case?
| | `ui:widget` | string | Yes | Must be `"AuthRequester"` | | ||
| | `ui:props.authTokenDescriptors` | array of objects | Yes | List of token requirements | | ||
| | — `provider` | string | Yes | One of `github`, `gitlab`, `microsoft`, etc. | | ||
| | — `tokenType` | string | Yes | `"oauth"` or `"openId"` | |
Member
There was a problem hiding this comment.
Let's mention what it means in reality:
- https://backstage.io/docs/reference/core-app-api.oauth2.getaccesstoken/
- https://backstage.io/docs/reference/core-app-api.oauth2.getidtoken/
With the providers added in the future, we will need to add a note that for some there is no support for both token types.
|
mareklibra
approved these changes
Jun 17, 2025
elai-shalev
pushed a commit
to elai-shalev/rhdh-plugins
that referenced
this pull request
Jan 21, 2026
…dget (redhat-developer#976) * docs(orchestrator): add documentation for using the auth requester widget * improvements following comments
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.