Validate User Permissions (POST)

Validate whether a user has the necessary org-level and user-level permissions to perform an insurance operation, such as creating a quote or policy. If the user isn’t authorized to perform the specified action, the API returns the validation status along with troubleshooting guidance.

Use this resource at design time to confirm that a user can perform a given insurance operation before guiding them through a setup flow. Provide a targetOperation value such as executeQuote, browseCatalog, or createPolicy. Optionally set userId. If userId isn’t specified, the API checks the current running user.

The API resolves org-level and user-level access checks for the operation. When the user is permitted, isValid is true. When a check fails, isValid is false and instructions names the missing permission set or lists supported operation identifiers. Examples include:

  • Unsupported or blank targetOperation — returns invalid with the list of supported values.
  • Missing policy admin access for quote or policy operations — for example, assign DigitalInsurancePolicyAdminUser.
  • Missing product admin access for catalog, rating, surcharge, underwriting rule, or clause operations — for example, assign DigitalInsuranceProductAdmin or DigitalInsuranceRunTimeProductAdmin.

Resource 

1/connect/insurance/design-advisor/user-permissions-validation

Resource Example 

Replace {yourInstance} with the My Domain name of your Salesforce org.

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/design-advisor/user-permissions-validation

Available Version 

68.0

HTTP Methods 

POST

Request Body for POST 

JSON Example 

1{
2  "targetOperation": "createPolicy",
3  "userId": "005xx000001X7roAAC"
4}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
targetOperationStringInsurance operation to validate against the user’s permission. Valid values are: executeQuote, browseCatalog, createQuote, rateProduct, createPolicy, endorsePolicy, cancelPolicy, reinstatePolicy, createSurcharge, createUnderwritingRules, and createClause. Unknown or blank values return an invalid result with the list of supported identifiers.Required68.0
userIdStringID of the user to check the permission for. If not specified, the API validates permission for the current user.Optional68.0

Response Body for POST 

Insurance Validate User Permissions Response