Approval

Checking the resource approval

post

Checks the approval for given resource. The endpoint verifies whether a user is authorized to perform a specific action on a given resource within a tenant. The user must be a Requestor or an Approver to have the required approval.approval_read_own scope.

In case of any validation problems, the below errorCodes can be returned:

• APPROVAL-400011: Requested user is not assigned to any company

Authorizations

CustomerAccessToken

AuthorizationstringRequired

To generate a customer access token, go to the Logging in a customer endpoint.

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name. Note: The tenant name should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Body

application/json

resourceTypestring · enumRequired

Type of resource under approval.

Possible values:

resourceIdstringRequired

An identifier of the resource for approval.

actionstring · enumRequired

Base schema for an approval action type.

Possible values:

Responses

200

Approval permitted response.

application/json

Base schema for approval permitted response.

actionstring · enumRequired

Base schema for an approval action type.

Possible values:

statusstring · enumOptional

Base schema for the approval status.

Possible values:

permittedbooleanRequired

Indicates if the operation is permitted.

approvalIdstringOptional

Identifier of the approval.

400

Bad request due to validation, incorrect parameters, etc.

application/json

401

Unauthorized.

application/json

403

Access forbidden. The caller is not allowed to access this resource.

application/json

post

/approval/{tenant}/approval/permitted

HTTPcURLJavaScriptPython

POST /approval/{tenant}/approval/permitted HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "resourceId": "cartId",
  "resourceType": "CART",
  "action": "CHECKOUT"
}

Check if action is permitted (cart)Check if action is permitted (quote)

{
  "status": "APPROVED",
  "action": "CHECKOUT",
  "permitted": true,
  "approvalId": "64ef8d12b6385140afea1603"
}