Mint an API key for a service account (org admin)
import requests
url = "https://eu.app.clarifeye.ai/api/v1/organization-api-keys/"
payload = {
"service_account": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
service_account: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
expires_at: '2023-11-07T05:31:56Z'
})
};
fetch('https://eu.app.clarifeye.ai/api/v1/organization-api-keys/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://eu.app.clarifeye.ai/api/v1/organization-api-keys/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"service_account": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"service_account": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>"
},
"name": "<string>",
"key_prefix": "<string>",
"status": "active",
"created_at": "2023-11-07T05:31:56Z",
"created_by": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"display_name": "<string>"
},
"expires_at": "2023-11-07T05:31:56Z",
"revoked_at": "2023-11-07T05:31:56Z",
"last_used_at": "2023-11-07T05:31:56Z",
"api_key": "<string>"
}Organization API Keys
Mint an API key for a service account (org admin)
The full api_key (prefixed cfk_) is returned ONCE in this response.
POST
/
organization-api-keys
/
Mint an API key for a service account (org admin)
import requests
url = "https://eu.app.clarifeye.ai/api/v1/organization-api-keys/"
payload = {
"service_account": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
service_account: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
expires_at: '2023-11-07T05:31:56Z'
})
};
fetch('https://eu.app.clarifeye.ai/api/v1/organization-api-keys/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://eu.app.clarifeye.ai/api/v1/organization-api-keys/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"service_account": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"service_account": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>"
},
"name": "<string>",
"key_prefix": "<string>",
"status": "active",
"created_at": "2023-11-07T05:31:56Z",
"created_by": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"display_name": "<string>"
},
"expires_at": "2023-11-07T05:31:56Z",
"revoked_at": "2023-11-07T05:31:56Z",
"last_used_at": "2023-11-07T05:31:56Z",
"api_key": "<string>"
}Authorizations
BearerAuthTokenAuth
Use Authorization: Bearer <token>. The token is either a user token / OAuth access
token, or a service-account API key (cfk_...). A key is valid on every endpoint and
acts as its service account, an organization member with per-store permissions.
Refused keys answer 403 with Invalid API key., API key revoked.,
API key expired. or API key disabled..
Body
application/json
Response
Created. Includes the one-time plaintext key.
API key metadata. Never includes the secret or its stored forms.
Show child attributes
Show child attributes
The 8 characters after cfk_, to recognise a key without revealing it.
Available options:
active, expired, revoked Show child attributes
Show child attributes
Full plaintext key — shown only here, once.