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

Write reference documentation for OIDC API tokens #4127

Open
5 tasks
indirect opened this issue Oct 11, 2023 · 0 comments
Open
5 tasks

Write reference documentation for OIDC API tokens #4127

indirect opened this issue Oct 11, 2023 · 0 comments
Assignees

Comments

@indirect
Copy link
Member

This should be a document in the Guides repo, named something like "OIDC API Key Reference", and can be based on the RFC reference-level explanation. It should explain:

  • what is OIDC
  • what is a provider, how do you view providers (presumably pointing towards /profile/oidc/providers)
  • what do each of the properties for a provider mean? what values can they have? what does each value do? (issuer, jwks uri, response types, subject types, signing alg, scopes, claims)
  • what is an API key role?
  • what do each of the properties for an API key role mean? what values can they have? what does each value do? (scopes, valid for, gems, statement effect and principal and conditions)
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

No branches or pull requests

2 participants