Depending on the type of license or hosted organization you are using, your GoodData environment may come with certain entitlements:
Some entitlements are public, they can be viewed by anyone. Other entitlements are non-public, they are suppressed in the API response unless the user making the request has the
Contract(non-public) defines how long you can use the organization for before you have to renew the contract. Note that you can host multiple organisations in the same deployment. While your deployment expires when your license expires, individual organizations expire according to their contract expiration dates. Contracts are only used for GoodData Cloud.
Tier(public) defines the level of service you have access to. Currently the tier entitlement is used to differentiate between the trial and enterprise tiers of GoodData.
CustomTheming(public) defines whether you can modify the visual style of your GoodData deployment.
ManagedOIDC(non-public) defines which OIDC Identity Provider is to be used in your deployment. This entitlement ensures that the OIDC Identity Provider is managed exclusively by GoodData; This is typically done for GoodData Cloud deployments. If your organization does not contain this entitlement, you are free to use any supported OIDC Identity provider.
UnlimitedWorkspaces(non-public) defines the maximum number of workspaces an organization can have.
UnlimitedUsers(non-public) defines the maximum number of users an organization can have.
There are two API endpoints that let you view your entitlements:
/api/v1/entities/entitlementsmay return the following organizational entitlements:
/api/v1/actions/resolveEntitlementsaggregates organizational entitlements, as well as entitlements taken from the license and any other stand-alone entitlements:
Contracttaken from organization
Tiertaken from organization
ManagedOIDCtaken from organization
UnlimitedWorkspacestaken from organization or license
UnlimitedUserstaken from organization or license
CustomTheminga stand-alone entitlement
To be able to easily monitor how many workspaces and users you currently have in your organization, use the
/api/v1/actions/collectUsage API endpoint. This API returns the following items:
WorkspaceCountshows how many workspaces currently exist in your organization
UserCountshow how many users currently exist in your organization
Note that the
Organization.MANAGE permission is required to make this API call.