API Authentication

The are two ways to authenticate against the backend in a development environment. The first is to use a personal access token (PAT) and the second is to use a bearer token.

Personal Access Tokens

Note

To create a personal access token you need a running frontend.

Find more information about authentication with personal access tokens in the user documentation: Authentication

Bearer Token

Request the auth_url

curl -X 'GET' \
  'http://127.0.0.1:8000/api/v1/authentication/' \
  -H 'accept: application/json'

Opening the auth_url in a browser leads you to a "Mock OAuth2 Server Sign-in" page.

Login as user admin to be redirected to a page that is reachable when the frontend runs. Anyway the redirect URL in the browser's address input field contains two parameters code and status.

Example:

    http://localhost:4200/oauth2/callback?...
    ...code=MREy4raZT9JqaYn_50yJraU4zkclGQbNcbudW404ekc...
    ...&state=r7huaqqdDBWTb8x4gUDIpt36izM0Au

One must copy these parameters and post them via a second request returning an access token:

curl -X 'POST' \
  'http://127.0.0.1:8000/api/v1/authentication/tokens' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "code": "MREy4raZT9JqaYn_50yJraU4zkclGQbNcbudW404ekc",
  "state": "r7huaqqdDBWTb8x4gUDIpt36izM0Au"
}'

To send a request using that token you may want to request the list of projects:

curl -X 'GET' \
  'http://127.0.0.1:8000/api/v1/projects/' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <TOKEN>'

whereby <TOKEN> must be replaced by the token you received above.

Using the Swagger UI one can click on the lock symbols to enter the access token.