Service account detail, with its stores and keys (org admin)
import requests
url = "https://eu.app.clarifeye.ai/api/v1/organizations/{id}/service-accounts/{user_id}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/organizations/{id}/service-accounts/{user_id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://eu.app.clarifeye.ai/api/v1/organizations/{id}/service-accounts/{user_id}/ \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"is_active": true,
"stores_count": 123,
"keys_count": 123,
"last_used_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"user_usage_limit_mode": "inherit",
"user_usage_alert_ccu": 123,
"user_usage_block_ccu": 123,
"effective_alert_ccu": 123,
"effective_block_ccu": 123,
"period_ccu": 123,
"alerted_this_period": true,
"blocked": true,
"stores": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_name": "<string>",
"permissions": [
"<string>"
],
"profile": "tech"
}
],
"keys": [
{
"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"
}
]
}Service Accounts
Service account detail, with its stores and keys (org admin)
GET
/
organizations
/
{id}
/
service-accounts
/
{user_id}
/
Service account detail, with its stores and keys (org admin)
import requests
url = "https://eu.app.clarifeye.ai/api/v1/organizations/{id}/service-accounts/{user_id}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/organizations/{id}/service-accounts/{user_id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://eu.app.clarifeye.ai/api/v1/organizations/{id}/service-accounts/{user_id}/ \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"is_active": true,
"stores_count": 123,
"keys_count": 123,
"last_used_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"user_usage_limit_mode": "inherit",
"user_usage_alert_ccu": 123,
"user_usage_block_ccu": 123,
"effective_alert_ccu": 123,
"effective_block_ccu": 123,
"period_ccu": 123,
"alerted_this_period": true,
"blocked": true,
"stores": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_name": "<string>",
"permissions": [
"<string>"
],
"profile": "tech"
}
],
"keys": [
{
"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"
}
]
}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..
Response
Service account.