Login with API Key

GET /api/v1/auth/login

Access Login

Using a StackHawk API Key, this endpoint returns an access token which can then be used in the authorization header of subsequent API requests. The access token returned is an RFC-7519 compliant jwt access token.

Access tokens have an expiration of 30 minutes and are issued on behalf of the requesting user.

An access token can only be used to interact with StackHawk resources that belong to the user, or to organizations that user is a part of and permissioned for.

For best practices, use the /login route only when starting a new access session to the StackHawk API, and use the /refresh route to request a fresh token to extend an API session.

Headers

X-ApiKeystringrequired

Specialized request header to supply your **StackHawk API Key** which authorizes further requests.

Response

200

A JSON Web Token used to authenticate requests to the StackHawk API

token

string

the bearer token value

token

string

the bearer token value

GET /api/v1/auth/login

cURL

curl --request GET \
  --url 'https://api.stackhawk.com/api/v1/auth/login' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Copy

Access Login

Headers

Response

Your privacy settings