JWT Scope Validation Policy

Validates that the JWT token includes specific scopes

Configuration

The configuration shows how to configure the policy in the 'policies.json' document.

{
  "name": "my-jwt-scopes-inbound-policy",
  "policyType": "jwt-scopes-inbound",
  "handler": {
    "export": "JWTScopeValidationInboundPolicy",
    "module": "$import(@zuplo/runtime)",
    "options": {
      "scopes": [
        "read:users",
        "write:projects"
      ]
    }
  }
}

Policy Configuration

  • name <string> - The name of your policy instance. This is used as a reference in your routes.
  • policyType <string> - The identifier of the policy. This is used by the Zuplo UI. Value should be jwt-scopes-inbound.
  • handler.export <string> - The name of the exported type. Value should be JWTScopeValidationInboundPolicy.
  • handler.module <string> - The module containing the policy. Value should be $import(@zuplo/runtime).
  • handler.options <object> - The options for this policy. See Policy Options below.

Policy Options

The options for this policy are specified below. All properties are optional unless specifically marked as required.

  • scopes <string[]> (Required) -
    An array of of JWT scopes.

Using the Policy

Read more about how policies work