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

Unify API Auth documentation #4117

Open
4 of 7 tasks
Tracked by #3649
pepopowitz opened this issue Aug 6, 2024 · 0 comments
Open
4 of 7 tasks
Tracked by #3649

Unify API Auth documentation #4117

pepopowitz opened this issue Aug 6, 2024 · 0 comments
Assignees
Labels
component:docs Documentation improvements, including new or updated content epic:api-interactivity theme:api-streamline Issues related to the theme of streamlining APIs

Comments

@pepopowitz
Copy link
Collaborator

pepopowitz commented Aug 6, 2024

Part of #3649.

Unify the content on our various API Authentication docs, so that each API Auth guide contains the following:

  • Steps to generate a token, in either a SaaS (if available) or self-managed (if available) environment
    • Clear description of environment variables to be downloaded when creating a client
  • An example auth call, in either a SaaS (if available) or self-managed (if available) environment
  • An example usage of a generated token, in either a SaaS (if available) or self-managed (if available) environment
  • A description of token expiration
  • Consistent authentication requests between SaaS and self-managed, such that plugging the sample SaaS auth request into an OOTB self-managed environment with the correct variables, will work. (See Incorrect curl command to request bearer token #4092 (comment))

Tasks

  1. 3 of 3
    component:docs deploy theme:api-streamline
    pepopowitz
  2. component:docs theme:api-streamline
    pepopowitz
  3. component:docs theme:api-streamline
    pepopowitz
  4. component:docs theme:api-streamline
    pepopowitz
  5. component:docs deploy theme:api-streamline
    pepopowitz
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content epic:api-interactivity theme:api-streamline Issues related to the theme of streamlining APIs
Projects
Status: 🏗 In Progress
Development

No branches or pull requests

1 participant