Rename, disable / re-enable, or set the usage limit (org admin)
import requests
url = "https://eu.app.clarifeye.ai/api/v1/organizations/{id}/service-accounts/{user_id}/"
payload = {
"name": "<string>",
"is_active": True,
"user_usage_alert_ccu": 123,
"user_usage_block_ccu": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
is_active: true,
user_usage_alert_ccu: 123,
user_usage_block_ccu: 123
})
};
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 PATCH \
--url https://eu.app.clarifeye.ai/api/v1/organizations/{id}/service-accounts/{user_id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"is_active": true,
"user_usage_alert_ccu": 123,
"user_usage_block_ccu": 123
}
'{
"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
}Service Accounts
Rename, disable / re-enable, or set the usage limit (org admin)
is_active: false disables the account: every one of its keys answers 403
API key disabled. until it is re-enabled. Its data and store access are kept.
Service accounts cannot be deleted.
PATCH
/
organizations
/
{id}
/
service-accounts
/
{user_id}
/
Rename, disable / re-enable, or set the usage limit (org admin)
import requests
url = "https://eu.app.clarifeye.ai/api/v1/organizations/{id}/service-accounts/{user_id}/"
payload = {
"name": "<string>",
"is_active": True,
"user_usage_alert_ccu": 123,
"user_usage_block_ccu": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
is_active: true,
user_usage_alert_ccu: 123,
user_usage_block_ccu: 123
})
};
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 PATCH \
--url https://eu.app.clarifeye.ai/api/v1/organizations/{id}/service-accounts/{user_id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"is_active": true,
"user_usage_alert_ccu": 123,
"user_usage_block_ccu": 123
}
'{
"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
}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
Updated.
The service account's user id.
Stores of this organization the account can access.
Active (not revoked, not expired) keys.
Available options:
inherit, unlimited, custom