api-keys

Create an API key

Changed on

Issues a new API key with the requested scopes. The plaintext key is returned only in this response and cannot be retrieved afterwards.

Required scope: `apikeys:issue`

The issued key is always weaker than the caller: the requested scopes must be a subset of the scopes held by the calling key, `apikeys:issue` itself cannot be granted, and `external_data:*` scopes are not issuable through this endpoint (they require dashboard sign-in).

This endpoint accepts API key authentication only. Issuing from the dashboard is done in the console, which is also the only way to grant `apikeys:issue` and `external_data:*`.

post/api-keys

Request

  • Base URL
    https://developer.qaip.com/api/v1
  • URL
    https://developer.qaip.com/api/v1/api-keys
  • Auth
    API key in header x-api-key

Request body

namestring required

Name of the API key

descriptionstring

Description of the API key

scopesIssuableApiKeyScope[] required

Scopes granted to the issued key. Must be a subset of the caller's scopes.

Response

API key created

idstring required

API key ID

namestring required

Name of the API key

descriptionstring

Description of the API key

keystring required

Plaintext API key. Returned only at creation time.

scopesIssuableApiKeyScope[] required

Scopes granted to this key

creation_timeinteger required

Creation time (Unix timestamp in seconds)

Changes

  • 2489c6f1a9d8Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 0375753f8ee3Revision changes
    • info

      endpoint deprecated

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status