Api keys

>>>

GET /api/v1/users/:user_id/api_keys
Return the users API keys.

Metadata

- Authentication: The user must be authenticated to perform this action.
>>>

POST /api/v1/users/:user_id/api_keys
Create a new API key.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
user_id
required

User id of the API key

Validations:

  • Must be a Integer
name
required

Name of the API key.

Validations:

  • Must be a String
>>>

DELETE /api/v1/user/:user_id/api_keys/:id
Delete the API key.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
id
required

ID of the API key to be deleted.

Validations:

  • Must be a String