Below you will find the various attributes for the entitlement resource. Entitlements
can be attached to policies and to licenses to grant named "permissions" for things
such as application features.
Entitlements can be attached to the following resources:
Policies: Any entitlement attached to a policy will automatically be attached to
all licenses which implement the given policy.
Licenses: Entitlements attached to a license are one-off and only apply to that
specific license resource.
Releases: Entitlements can be attached to releases through constraints,
in order to assert that a given licensee possesses the necessary entitlements
before being allowed to access a release's artifacts.
linkAttributes
linkdata.attributes.name
string
The name of the entitlement.
linkdata.attributes.code
string
The unique code for the entitlement. This can be used within license validation requests to assert a license possesses a given entitlement.
A 201 Created response will be returned along with the new entitlement object.
Upon error, an errors object will be returned along with an
HTTP status code indicating the type of error. When an error occurs, the
data property will not be included.
An authentication token with privileges to view the resources: either an admin, a product, a license which the entitlement is attached to (via license key or a license token), or a user which the entitlements is attached to.
linkURL parameters
link
stringrequired
The identifier (UUID) or slug of your Keygen account.
link
stringrequired
The identifier (UUID) of the entitlement to be retrieved.
linkReturns
A 200 OK response will be returned along with an entitlement object.
Upon error, an errors object will be returned along with an
HTTP status code indicating the type of error. When an error occurs, the
data property will not be included.
Updates the specified entitlement resource by setting the values of the parameters
passed. Any parameters not provided will be left unchanged.
Renaming an entitlement code that is already in use may cause license validations
using the old entitlement code to fail. We suggest making sure the existing code
is no longer in use before changing it, to prevent unintended license validation
failures.
linkRequired permissions
entitlement.update
linkAuthentication
linkBearer
required
An authentication token with privileges to manage the resource: an admin.
linkURL parameters
link
stringrequired
The identifier (UUID) or slug of your Keygen account.
link
stringrequired
The identifier (UUID) of the entitlement to be updated.
A 200 OK response will be returned along with the updated entitlement object.
Upon error, an errors object will be returned along with an
HTTP status code indicating the type of error. When an error occurs, the
data property will not be included.
Permanently deletes an entitlement. The entitlement will immediately be removed from all licenses
and policies. It cannot be undone.
linkRequired permissions
entitlement.delete
linkAuthentication
linkBearer
required
An authentication token with privileges to manage the resource: an admin.
linkURL parameters
link
stringrequired
The identifier (UUID) or slug of your Keygen account.
link
stringrequired
The identifier (UUID) of the entitlement to be deleted.
linkReturns
A 204 No Content response will be returned.
Upon error, an errors object will be returned along with an
HTTP status code indicating the type of error. When an error occurs, the
data property will not be included.
Returns a list of entitlements. The entitlements are returned sorted by creation date,
with the most recent entitlements appearing first. Resources are automatically
scoped to the authenticated bearer e.g. when authenticated as a license,
only entitlements attached to that specific license will be listed.
To list entitlements for an individual policy
or license, use the given resource's
scoped entitlements relationship.
linkRequired permissions
entitlement.read
linkAuthentication
linkBearer
required
An authentication token with privileges to view the resources: either an admin, a product, a license which the entitlements are attached to (via license key or a license token), or a user which the entitlements are attached to.
linkURL parameters
link
stringrequired
The identifier (UUID) or slug of your Keygen account.
linkQuery parameters
linklimit
integerdefault=10
A limit on the number of entitlements to be returned. Limit must be a number between 1 and 100.
/v1/accounts//entitlements?limit=25
linkpage
object
Object containing page size and page number. Page size must be a number between 1 and 100.
A 200 OK response will be returned along with a list of entitlement objects.
Upon error, an errors object will be returned along with an
HTTP status code indicating the type of error. When an error occurs, the
data property will not be included.