EntitlementsTemplate

Get all entitlements templates for regulated and customer roles

Returns a list of entitlements templates for regulated and customer roles only. Regulated users cannot view internal templates. Can be filtered to show only active templates and/or templates for specific roles.

get/api-regulated/v1/entitlements-templates

Request

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

Query parameters

activeOnlyboolean

Filter to show only active templates

rolestring

Filter templates by role (REST_REGULATED, REST_SALES, REST_CUSTOMER)

Response

Templates retrieved successfully

idstring uuid

The unique identifier for the entitlements template.

templateNamestring

The unique name of the entitlements template.

descriptionstring

Description of what this template provides.

userType'INTERNAL' | 'REGULATED' | 'CUSTOMER' | 'SALES'

The user type this template applies to.

isActiveboolean

Whether this template is active and can be assigned to users.

versionNumberinteger

The strictly monotonically increasing version number for this record.

updatedBystring

The username of the person or entity that updated this record.

updatedAtstring

The timestamp of the last update in UTC.

createdAtstring

The timestamp of creation in UTC.

Example response

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "templateName": "Super User",
    "description": "Full administrative access with all permissions",
    "userType": "REGULATED",
    "isActive": true,
    "versionNumber": 1,
    "updatedBy": "jbloggs24",
    "updatedAt": "2024-10-18T12:30:40Z",
    "createdAt": "2024-10-18T12:30:40Z"
  }
]

Changes

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