Authenticate request based on extracted identity
Table 1. Supported parameters
| Parameter |
Required |
Data type |
Details |
| namespace |
No |
string |
Context namespace to exchange data with other security actions. Default value "user" |
| operation |
Yes |
object |
Operation to perform to authenticate current request |
Table 2. Options for
operation
| Options |
Required |
Data type |
Details |
| apiDefinition |
Yes |
object |
Authenticate based on the security scheme(s) defined in the API Definition |
| subscription |
Yes |
object |
Authenticate using the configured subscription service |
| jwt |
Yes |
object |
Authenticate the extracted JWT token using the configured JWT provider |
| oauth2 |
Yes |
object |
Authenticate the extracted OAuth token using the configured OAuth provider |
Table 3. Nested properties inside
jwt
| Property |
Required |
Data type |
Details |
| audClaim |
No |
array of string |
Expected audience claim which will use to compare against the aud claim in the token payload.
If this field is not configured, there will be no extra validation on the aud claim |
| providers |
Yes |
array of string |
Array of strings that specifies the names of the JWT providers configured in the
gateway |
Table 4. Nested properties inside
oauth2
| Property |
Required |
Data type |
Details |
| audClaim |
No |
array of string |
Expected audience claim which will use to compare against the aud claim in the token payload.
If this field is not configured, there will be no extra validation on the aud claim |
| introspectionCredential |
No |
object |
Defines custom credentials for performing remote token introspection with the OAuth
provider |
| providers |
Yes |
array of string |
Specifies the names of the configured OAuth providers that will be used to validate the
extracted OAuth token |
Table 5. Options for
introspectionCredential
| Property |
Required |
Data type |
Details |
| FromClientRequest |
No |
object |
Expected audience claim which will use to compare against the aud claim in the token payload.
If this field is not configured, there will be no extra validation on the aud claim |
| Info missing in HTML file |
|
|
|