EntitlementsTemplate

Get all available entitlements

Returns a list of all entitlement definitions available in the system. Internal entitlements are excluded for regulated and customer users. These can be used to build entitlements templates.

get/api-regulated/v1/entitlements-templates/entitlements

Request

  • Base URL: https://api.currencyguard.com
  • URL: https://api.currencyguard.com/api-regulated/v1/entitlements-templates/entitlements
  • Auth: HTTP bearer

Response

Entitlements retrieved successfully

keystring

The dot-notation key that corresponds to the JSON structure

descriptionstring

Human-readable description of what this entitlement allows

categorystring

The category this entitlement belongs to

scopestring

The scope of this entitlement (internal, sales, customer)

functionalAreastring

The functional area this entitlement covers

Example response

[
  {
    "key": "internal.risk-management.canEnterFXOptionTrades",
    "description": "Entitles the internal user to enter FX option trades on behalf of customers",
    "category": "internal.risk-management",
    "scope": "internal",
    "functionalArea": "risk-management"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.