Skip to Content
kosemdocs
ReferenceAPIEntitlements

Get entitlement in organization

Gets what an organization gets of one of kosem's features.

GET
/v1/organizations/{organization}/entitlements/{entitlement}

Gets what an organization gets of one of kosem's features.

Authorization

bearer
headerAuthorizationBearer <token>

An access token, or an API key.

Path Parameters

organization*string

The organization's ID.

Match^org_[0-7][0-9a-hjkmnp-tv-z]{25}$
entitlement*string

The feature's ID, such as auditlog.auditLogs.

Match^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)+$

Response Body

OK

application/json
  1. response
acrossPlans?boolean

True when a staff override applies across every plan the organization moves to, rather than only its current plan.

adjustment*string

How the organization gets more: UPGRADE, a higher self-serve plan gives more; REQUEST, a LIMIT on Team or Enterprise, which kosem raises when the organization asks; FIXED, no plan it moves to by itself gives more.

Value in"FIXED""UPGRADE""REQUEST"
displayName*string

Name shown in user interfaces, such as Audit logs.

enabled*boolean

Whether the organization has the feature: for a BOOLEAN, its value is 1; for a NUMBER or a LIMIT, above 0.

feature*string

The feature's ID: the service, then what it is, such as auditlog.auditLogs or resourcemanager.projects.

name*string

Resource name, organizations/{organization_id}/entitlements/{feature} or projects/{project_id}/entitlements/{feature}.

overridden*boolean

Whether kosem set the organization's value, in place of its plan's. It applies while the organization stays on its plan, unless acrossPlans is set.

planValue*integer

The organization's plan's value, which value replaces when overridden; the same as value otherwise.

Formatint64
requiredPlan?string

The lowest self-serve plan above the organization's that gives more of this feature (PRO or TEAM); omitted when none does.

Value in"PRO""TEAM"
type*string

BOOLEAN, a feature the organization has or doesn't; NUMBER, a setting in unit, such as 7 days; LIMIT, the most it may have or use, which its quota of the same ID counts and enforces.

Value in"BOOLEAN""NUMBER""LIMIT"
unit*string

What a NUMBER or a LIMIT counts, in the plural, such as days or projects; empty for a BOOLEAN.

unlimitedZero?boolean

True for a NUMBER feature where 0 means unlimited (kept until deleted).

value*integer

The organization's value: its plan's, or one kosem set for it in its place (overridden). A BOOLEAN's is 1 or 0.

Formatint64
Example Request
curl -X GET 'https://api.kosem.ai/v1/organizations/string/entitlements/string'
Example Response
{
  "acrossPlans": true,
  "adjustment": "FIXED",
  "displayName": "string",
  "enabled": true,
  "feature": "string",
  "name": "string",
  "overridden": true,
  "planValue": 0,
  "requiredPlan": "PRO",
  "type": "BOOLEAN",
  "unit": "string",
  "unlimitedZero": true,
  "value": 0
}