POST
/
api
/
user
/
api_key

Authorizations

Authorization
string
headerrequired

Body

application/json
dataset_ids
string[] | null

The dataset ids which the api key will have access to. If not provided or empty, the api key will have access to all datasets the auth'ed user has access to. If both dataset_ids and organization_ids are provided, the api key will have access to the intersection of the datasets and organizations.

default_params
object

The default parameters which will be forcibly used when the api key is given on a request. If not provided, the api key will not have default parameters.

expires_at
string | null

The expiration date of the api key. If not provided, the api key will not expire. This should be provided in UTC time.

name
string
required

The name which will be assigned to the new api key.

organization_ids
string[] | null

The organization ids which the api key will have access to. If not provided or empty, the api key will have access to all organizations the auth'ed user has access to.

role
integer
required

The role which will be assigned to the new api key. Either 0 (read), 1 (read and write at the level of the currently auth'ed user). The auth'ed user must have a role greater than or equal to the role being assigned which means they must be an admin (1) or owner (2) of the organization to assign write permissions with a role of 1.

scopes
string[] | null

The routes which the api key will have access to. If not provided or empty, the api key will have access to all routes the auth'ed user has access to. Specify the routes as a list of strings. For example, ["GET /api/dataset", "POST /api/dataset"].

Response

200 - application/json
api_key
string
required

The api key which was created. This is the value which should be used in the Authorization header.