Skip to content

Authentication

Jump to bottom
iDigitalFlame edited this page Apr 6, 2021 · 2 revisions

The Scorebot API requires authentication on many of it's endpoints.

Authentication in Scorebot is based on a permissions based system. Each endpoint may have it's own separate permission.

Authentication takes the form of a token expressed in UUID4 format.

Tokens must be provided in an HTTP header to be processed. There are two headers that can be used.

  • APIv1 and APIv2: SBE-AUTH: <Token UUID> deprecated
  • APIv2: Authentication: <Token UUID>

HTTP Responses will always follow the form of 401 -> 403.

Status Response Meaning
401 Authentication token is missing.
403 Missing permission or token is not valid for this endpoint.

Clone this wiki locally