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

Go to download
{
  "type" : "object",
  "id" : "urn:jsonschema:io:gravitee:resource:oauth2:generic:configuration:OAuth2ResourceConfiguration",
  "properties" : {
    "introspectionEndpoint" : {
      "title": "Token introspection endpoint",
      "description": "The URL which is used by the resource to introspect an incoming access token.",
      "type" : "string"
    },
    "introspectionEndpointMethod" : {
      "title": "Token introspection method",
      "description": "HTTP method used to introspect the access token.",
      "type" : "string",
      "enum": [
        "GET",
        "POST"
      ],
      "default": "GET"
    },
    "clientId" : {
      "title": "Client Id",
      "description": "The client identifier.",
      "type" : "string"
    },
    "clientSecret" : {
      "title": "Client Secret",
      "description": "The client secret.",
      "type" : "string"
    },
    "useClientAuthorizationHeader": {
      "title": "Use HTTP header for client authorization",
      "description": "To prevent token scanning attacks, the endpoint MUST also require some form of authorization to access this endpoint. In this case we are using an HTTP header for client authentication.",
      "type" : "boolean",
      "default": true
    },
    "clientAuthorizationHeaderName" : {
      "type" : "string",
      "title": "Authorization header.",
      "default": "Authorization"
    },
    "clientAuthorizationHeaderScheme" : {
      "type" : "string",
      "title": "Authorization scheme.",
      "default": "Basic"
    },
    "tokenIsSuppliedByQueryParam" : {
      "title": "Use a query parameter to supply access token",
      "description": "Access token is passed to the introspection endpoint using a query parameter.",
      "type" : "boolean",
      "default": true
    },
    "tokenQueryParamName" : {
      "title": "Token query param name",
      "description": "Query parameter used to supply access token.",
      "type" : "string",
      "default": "token"
    },
    "tokenIsSuppliedByHttpHeader" : {
      "title": "Use an HTTP header to supply access token",
      "description": "Access token is passed to the introspection endpoint using an HTTP header.",
      "type" : "boolean",
      "default": false
    },
    "tokenHeaderName" : {
      "title": "HTTP header name",
      "description": "HTTP header used to supply access token.",
      "type" : "string"
    },
    "tokenIsSuppliedByFormUrlEncoded" : {
      "title": "Use application/x-www-form-urlencoded form to send access token",
      "description": "Send access token in application/x-www-form-urlencoded form.",
      "type" : "boolean",
      "default": false
    },
    "tokenFormUrlEncodedName" : {
      "title": "Form param name",
      "description": "Name of the form param in case of application/x-www-form-urlencoded.",
      "type" : "string",
      "default": "token"
    }
  },
  "required": [
    "introspectionEndpoint",
    "introspectionEndpointMethod",
    "clientId",
    "clientSecret"
  ]
}