Contents

# OryOathkeeperClient::Rule

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **authenticators** | [**Array<RuleHandler>**](RuleHandler.md) | Authenticators is a list of authentication handlers that will try and authenticate the provided credentials. Authenticators are checked iteratively from index 0 to n and if the first authenticator to return a positive result will be the one used.  If you want the rule to first check a specific authenticator  before \"falling back\" to others, have that authenticator as the first item in the array. | [optional] |
| **authorizer** | [**RuleHandler**](RuleHandler.md) |  | [optional] |
| **description** | **String** | Description is a human readable description of this rule. | [optional] |
| **id** | **String** | ID is the unique id of the rule. It can be at most 190 characters long, but the layout of the ID is up to you. You will need this ID later on to update or delete the rule. | [optional] |
| **match** | [**RuleMatch**](RuleMatch.md) |  | [optional] |
| **mutators** | [**Array<RuleHandler>**](RuleHandler.md) | Mutators is a list of mutation handlers that transform the HTTP request. A common use case is generating a new set of credentials (e.g. JWT) which then will be forwarded to the upstream server.  Mutations are performed iteratively from index 0 to n and should all succeed in order for the HTTP request to be forwarded. | [optional] |
| **upstream** | [**Upstream**](Upstream.md) |  | [optional] |

## Example

```ruby
require 'ory-oathkeeper-client'

instance = OryOathkeeperClient::Rule.new(
  authenticators: null,
  authorizer: null,
  description: null,
  id: null,
  match: null,
  mutators: null,
  upstream: null
)
```

Version data entries

40 entries across 40 versions & 1 rubygems

Version	Path
ory-oathkeeper-client-0.40.8	docs/Rule.md
ory-oathkeeper-client-0.40.6	docs/Rule.md
ory-oathkeeper-client-0.40.5	docs/Rule.md
ory-oathkeeper-client-0.40.4	docs/Rule.md
ory-oathkeeper-client-0.40.2	docs/Rule.md
ory-oathkeeper-client-0.39.4	docs/Rule.md
ory-oathkeeper-client-0.39.2	docs/Rule.md
ory-oathkeeper-client-0.39.0	docs/Rule.md
ory-oathkeeper-client-0.38.25.beta1	docs/Rule.md
ory-oathkeeper-client-0.38.24.beta1	docs/Rule.md
ory-oathkeeper-client-0.38.23.beta1	docs/Rule.md
ory-oathkeeper-client-0.38.22.beta1	docs/Rule.md
ory-oathkeeper-client-0.38.20.beta1	docs/Rule.md
ory-oathkeeper-client-0.38.19.beta1	docs/Rule.md
ory-oathkeeper-client-0.38.18.beta1	docs/Rule.md
ory-oathkeeper-client-0.38.17.beta1	docs/Rule.md
ory-oathkeeper-client-0.38.15.beta1	docs/Rule.md
ory-oathkeeper-client-0.0.0.alpha62	docs/Rule.md
ory-oathkeeper-client-0.0.0.alpha60	docs/Rule.md
ory-oathkeeper-client-0.0.0.alpha59	docs/Rule.md