QUquivaworks
API Keys

Issue API key

Changed on

Issues a new API key. The full key is returned once. User keys act as the issuing user and work on every endpoint that user can reach. Account keys (scope: account) can be issued only by root and administrators. Keys expire after 90 days unless expiry_days says otherwise. This is not an API integration: integrations are machine identities for task sync only.

post/accounts/api-key

Request

Request body

key_namestring required

API key name

emailstring email

Issue the key for another user of the account (root and administrators only). Defaults to the caller.

scope'user' | 'account'

user keys act as the issuing user. account keys are shared by the account and can be issued only by root and administrators.

expiry_daysinteger

Days until the key expires. Defaults to 90. A negative value means the key does not expire.

allow_sub_subjectsstring[]
deny_sub_subjectsstring[]
allow_pub_subjectsstring[]
deny_pub_subjectsstring[]

Response

API key created successfully

Changes

  • 700eb1ace61aRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 4979dfd00edaRevision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the required property to the response with the status