Skip to content

Features ​

Lists the features an application can grant, or adds and removes features from that list.

Only ServiceBenchElite uses this catalog.

GET /fieldservicegateway/usermanagement/v3/authorization/features

POST /fieldservicegateway/usermanagement/v3/authorization/features

List features ​

GET uses query parameters.

FieldRequiredDescription
applicationIdyesServiceBenchElite
includeChildrennotrue includes features under each module. Defaults to true. Send false to return modules only
modulenoReturn only this module

Example ​

GET /fieldservicegateway/usermanagement/v3/authorization/features?applicationId=ServiceBenchElite&includeChildren=true

cURL ​

bash
curl --request GET 'https://[BASE_URL]/fieldservicegateway/usermanagement/v3/authorization/features?applicationId=ServiceBenchElite&includeChildren=true' \
  --header 'x-api-key: {{x-api-key}}' \
  --header 'Authorization: {{Authorization}}' \
  --header 'Asurion-correlationid: correlation-id' \
  --header 'Asurion-enduser: end-user' \
  --header 'Asurion-sourcesystem: source-system' \
  --header 'Asurion-serviceprovider: company-id' \
  --header 'Asurion-client: default'

Response ​

200 OK

json
{
  "success": true,
  "data": {
    "applicationId": "ServiceBenchElite",
    "features": [
      {
        "module": "jobmanagement",
        "features": ["jobs_list_search"]
      }
    ]
  }
}

Add or remove features ​

Send at least one of assignFeatures or unassignFeatures.

FieldTypeRequiredDescription
applicationIdstringyesServiceBenchElite
assignFeaturesarrayone list is requiredModules and child features to add
unassignFeaturesarrayone list is requiredModules and child features to remove
assignFeatures[].modulestringyesModule name. No : or /
assignFeatures[].featuresstring[]noChild feature names under that module

Example ​

json
{
  "applicationId": "ServiceBenchElite",
  "assignFeatures": [
    {
      "module": "jobmanagement",
      "features": ["jobs_list_search"]
    }
  ]
}

cURL ​

bash
curl --request POST 'https://[BASE_URL]/fieldservicegateway/usermanagement/v3/authorization/features' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: {{x-api-key}}' \
  --header 'Authorization: {{Authorization}}' \
  --header 'Asurion-correlationid: correlation-id' \
  --header 'Asurion-enduser: end-user' \
  --header 'Asurion-sourcesystem: source-system' \
  --header 'Asurion-serviceprovider: company-id' \
  --header 'Asurion-client: default' \
  --data '{
    "applicationId": "ServiceBenchElite",
    "assignFeatures": [
      {
        "module": "jobmanagement",
        "features": ["jobs_list_search"]
      }
    ]
  }'

Response ​

201 Created

json
{
  "success": true,
  "data": {
    "applicationId": "ServiceBenchElite",
    "assigned": {
      "parents": 1,
      "children": 1
    },
    "unassigned": {
      "parents": 0,
      "children": 0
    }
  }
}

parents is the number of modules changed. children is the number of features under those modules.

Errors ​

StatusCodeWhen
400VALIDATION_ERRORapplicationId is missing, or the application is not ServiceBenchElite
500INTERNAL_ERRORSomething unexpected failed
json
{
  "success": false,
  "error": "Feature catalog is only supported for ServiceBenchElite",
  "code": "VALIDATION_ERROR",
  "details": {
    "fields": [
      {
        "field": "applicationId",
        "message": "Feature catalog is not supported for application 'Honeycomb'",
        "code": "APPLICATION_NOT_SUPPORTED"
      }
    ]
  },
  "correlationId": "correlation-id",
  "timestamp": "2026-10-16T00:00:00.000Z"
}