Skip to content

OAuth

The OAuth endpoint is used by third-party applications to obtain or refresh an access token (access_token). Once you have the token, subsequent business endpoints accept it through any of the methods described in Authentication.

This endpoint is not on the API domain and has no /api/v5 version prefix, which is the biggest difference from the other groups in this documentation.

Objects

Object Description Related endpoint
Access token The access_token that an application exchanges or refreshes through OAuth authorization Get or refresh authorization token endpoint

Identification method

  • The endpoint is fixed: POST https://atomgit.com/oauth/token (note that the host is atomgit.com, not api.atomgit.com).
  • The grant type, client credentials, and returned fields are passed as described in the parameter table on the specific endpoint page.

Common tasks

Task Endpoint
Obtain or refresh an access token POST https://atomgit.com/oauth/token

Notes

  • The path belongs to a different family from the other endpoints: it has no /api/v5 prefix and the host is not api.atomgit.com. When you build the path by hand with curl, it is easy to write https://api.atomgit.com/oauth/token, which fails.
  • This endpoint handles a single action, "obtain or refresh": the initial exchange and later refreshes use the same endpoint.
  • For how to call APIs once you have the token (Authorization: Bearer, the PRIVATE-TOKEN header, or the access_token query parameter), see Authentication.

Endpoint list

This module contains 1 endpoint.

# Endpoint Method and path Description
1 Get or refresh authorization token endpoint POST https://atomgit.com/oauth/token A unified endpoint that users call to obtain or refresh an access token (access_token)

Markdown source: View on AtomGit·Content from the open-source project gitcode-dev/atomgit-api-doc