Authorization Service

The authorization service request messages used by external authorization network filter and HTTP filter.

service.auth.v3.CheckRequest

[service.auth.v3.CheckRequest proto]

{
  "attributes": "{...}"
}
attributes

(service.auth.v3.AttributeContext) The request attributes.

service.auth.v3.DeniedHttpResponse

[service.auth.v3.DeniedHttpResponse proto]

HTTP attributes for a denied response.

{
  "status": "{...}",
  "headers": [],
  "body": "..."
}
status

(type.v3.HttpStatus, REQUIRED) This field allows the authorization service to send a HTTP response status code to the downstream client other than 403 (Forbidden).

headers

(config.core.v3.HeaderValueOption) This field allows the authorization service to send HTTP response headers to the downstream client.

body

(string) This field allows the authorization service to send a response body data to the downstream client.

service.auth.v3.OkHttpResponse

[service.auth.v3.OkHttpResponse proto]

HTTP attributes for an OK response.

{
  "headers": [],
  "dynamic_metadata": "{...}"
}
headers

(config.core.v3.HeaderValueOption) HTTP entity headers in addition to the original request headers. This allows the authorization service to append, to add or to override headers from the original request before dispatching it to the upstream. By setting append field to true in the HeaderValueOption, the filter will append the correspondent header value to the matched request header. Note that by Leaving append as false, the filter will either add a new header, or override an existing one if there is a match.

dynamic_metadata

(Struct) Optional response metadata that will be emitted as dynamic metadata to be consumed by the next filter. This metadata lives in a namespace specified by the canonical name of extension filter that requires it:

service.auth.v3.CheckResponse

[service.auth.v3.CheckResponse proto]

Intended for gRPC and Network Authorization servers only.

{
  "status": "{...}",
  "denied_response": "{...}",
  "ok_response": "{...}"
}
status

(Status) Status OK allows the request. Any other status indicates the request should be denied.

denied_response

(service.auth.v3.DeniedHttpResponse) Supplies http attributes for a denied response.

An message that contains HTTP response attributes. This message is used when the authorization service needs to send custom responses to the downstream client or, to modify/add request headers being dispatched to the upstream.

Only one of denied_response, ok_response may be set.

ok_response

(service.auth.v3.OkHttpResponse) Supplies http attributes for an ok response.

An message that contains HTTP response attributes. This message is used when the authorization service needs to send custom responses to the downstream client or, to modify/add request headers being dispatched to the upstream.

Only one of denied_response, ok_response may be set.