Skip to content

Clarify information about tokens in API docs  #19656

Open
@kelseiv

Description

@kelseiv

@AlirieGray @brettbuddin @GeorgeMac
cc @stephanie-engel @rhajek

Currently, if folks search for "create a token"
https://docs.influxdata.com/influxdb/v2.0/api/

Screen Shot 2020-09-28 at 12 00 50 PM

We see "Create an authorization" 6th in the list. Not all folks are tying together "create a token" and "create an authorization"

  • Perhaps we could add a key for the Create an authorization page, so results show both "Create an authorization" and "Create a token-based authorization" or "Create an authorization (token)".

  • Under the "Create an authorization" heading, lets add statement directly under heading to clarify: Create an authorization for a specified organization; this authorization defines permissions and creates a token to use in API requests.

  • Next to description: A description of the authorization. Currently, all authorizations (create a token/are token-based?). ....Would folks ever use an existing token to create an authorization?

  • Next to permissions: List of permissions for an authorization. Must have at least one permission. Add possible permissions-read/write/all access? Also, what is the "id" under permissions in the Response sample indicate?

  • In the request and response samples, under permissions, does the id indicate the user ID and does name indicate the user name?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions