schemas.schema-form.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gravitee-policy-oauth2 Show documentation
Check access token validity during request processing using token introspection
The newest version!
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "oauthResource": {
            "title": "OAuth2 resource",
            "description": "OAuth2 resource used to validate token. Supports EL.",
            "type": "string",
            "x-schema-form": {
                "event": {
                    "name": "fetch-resources",
                    "regexTypes": "^oauth2"
                },
                "placeholder": "oauth-resource-name"
            },
            "gioConfig": {
                "uiType": "resource-type",
                "uiTypeProps": {
                    "resourceType": "oauth2"
                }
            }
        },
        "oauthCacheResource": {
            "title": "Cache resource",
            "description": "Cache resource used to store the tokens.",
            "type": "string",
            "x-schema-form": {
                "event": {
                    "name": "fetch-resources",
                    "regexTypes": "^cache"
                },
                "placeholder": "cache-resource-name"
            },
            "gioConfig": {
                "uiType": "resource-type",
                "uiTypeProps": {
                    "resourceType": "cache"
                }
            }
        },
        "extractPayload": {
            "title": "Extract OAuth2 payload",
            "description": "Push the token endpoint payload into the 'oauth.payload' context attribute.",
            "type": "boolean",
            "default": false
        },
        "checkRequiredScopes": {
            "title": "Check scopes",
            "description": "Check required scopes to access the resource",
            "type": "boolean",
            "default": false
        },
        "requiredScopes": {
            "type": "array",
            "title": "Required scopes",
            "description": "List of required scopes to access the resource.",
            "items": {
                "type": "string",
                "title": "Scope"
            }
        },
        "modeStrict": {
            "title": "Mode strict",
            "description": "Check scopes with exactly those configured",
            "type": "boolean",
            "default": true
        },
        "propagateAuthHeader": {
            "title": "Permit authorization header to the target endpoints",
            "description": "Allows to propagate Authorization header to the target endpoints",
            "type": "boolean",
            "default": true
        }
    },
    "required": ["oauthResource"],
    "additionalProperties": false
}