White Label Admin - Add organization API key

White Label Admin - Add organization API key

White label admin only API to add an API key to an organization. Add a temporary API key that can be used to make Organizations API (/api/organizations/{organizationId}/) requests on behalf of the organization. These API keys are not visible to the organization itself and have a customizable TTL defaulting to 1 minute.

post

/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/apiKeys

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerrequired

Organization ID

innerOrganizationIdintegerrequired

Organization ID within the context of a white label

Body

namestringrequired

Description of the key

apiKeystring

Optional: API key. This needs to start with ei_ and will need to be at least 32 characters long. If this field is not passed in, a new API key is generated for you.

rolestring · enumrequired

Options: admin, member

ttlinteger

Time to live in seconds. If not set, the key will expire in 1 minute.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/apiKeys' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","role":"admin"}'

200

200

{
  "success": true,
  "error": "text",
  "id": 1,
  "apiKey": "text"
}

OK