Skip to main content

controlApprovalCoverage

Requires permission settings:controls:manage.

Who could approve requests needing each approval permission, and setup warnings (a payment-gated control with nothing verifying payments; a permission only one person holds). Only approval permissions are accepted. Requires settings:controls:manage.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

query ControlApprovalCoverage($includeMe: Boolean!, $permissions: [String!]!) {
  controlApprovalCoverage(includeMe: $includeMe, permissions: $permissions) {
    items {
      coversActive
      eligibleCount
      permission
      sample
    }
  }
}

Variables:

{
  "includeMe": true,
  "permissions": [
    "string"
  ]
}

Response:

{
  "data": {
    "controlApprovalCoverage": {
      "items": [
        {
          "coversActive": true,
          "eligibleCount": 0,
          "permission": "string",
          "sample": [
            "string"
          ]
        }
      ]
    }
  }
}
controlApprovalCoverage(
  includeMe: Boolean! = false
  permissions: [String!]!
): ControlApprovalCoverageType!

Arguments​

controlApprovalCoverage.includeMe ● Boolean! non-null scalar​

Count you among the approvers. Off by default: the setup check asks who other than you could approve.

controlApprovalCoverage.permissions ● [String!]! non-null scalar​

Approval permissions to check, such as approvals:large_orders:approve.

Type​

ControlApprovalCoverageType object​

Approver coverage for some approval permissions, with setup warnings.