= Cheatsheets

[[AuthOptions]]
== AuthOptions

++++
A common base object for authentication options.<p>
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|===

[[JWTOptions]]
== JWTOptions


[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[algorithm]]`@algorithm`|`String`|-
|[[audience]]`@audience`|`Array of String`|-
|[[audiences]]`@audiences`|`Array of String`|-
|[[expiresInMinutes]]`@expiresInMinutes`|`Number (int)`|-
|[[expiresInSeconds]]`@expiresInSeconds`|`Number (int)`|-
|[[header]]`@header`|`Json object`|-
|[[ignoreExpiration]]`@ignoreExpiration`|`Boolean`|-
|[[issuer]]`@issuer`|`String`|-
|[[leeway]]`@leeway`|`Number (int)`|-
|[[noTimestamp]]`@noTimestamp`|`Boolean`|-
|[[permissions]]`@permissions`|`Array of String`|+++
The permissions of this token.
+++
|[[scopeDelimiter]]`@scopeDelimiter`|`String`|+++

+++
|[[scopes]]`@scopes`|`Array of String`|+++

+++
|[[subject]]`@subject`|`String`|-
|===

[[KeyStoreOptions]]
== KeyStoreOptions

++++
Options describing how an JWT KeyStore should behave.
This is an extended version core's link.
<p>
This extension sets the default type to the runtime keystore type (for compatibility, reasons)
plus it allows the configuration of password per key using link.
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[password]]`@password`|`String`|-
|[[passwordProtection]]`@passwordProtection`|`String`|-
|[[path]]`@path`|`String`|-
|[[provider]]`@provider`|`String`|-
|[[type]]`@type`|`String`|-
|[[value]]`@value`|`Buffer`|-
|===

[[PubSecKeyOptions]]
== PubSecKeyOptions

++++
Options describing Key stored in PEM format.
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[algorithm]]`@algorithm`|`String`|-
|[[buffer]]`@buffer`|`String`|+++
The PEM or Secret key buffer
+++
|[[certificate]]`@certificate`|`Boolean`|-
|[[id]]`@id`|`String`|-
|[[publicKey]]`@publicKey`|`String`|+++

+++
|[[secretKey]]`@secretKey`|`String`|+++

+++
|[[symmetric]]`@symmetric`|`Boolean`|-
|===

[[TokenCredentials]]
== TokenCredentials

++++
Credentials used by any link that requires Tokens, such as OAuth2 or JWT
to perform its authentication
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[token]]`@token`|`String`|-
|===

[[UsernamePasswordCredentials]]
== UsernamePasswordCredentials

++++
Credentials used by any link that requires tokens, for example JWT, Oauth2, OpenId Connect
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[password]]`@password`|`String`|-
|[[username]]`@username`|`String`|-
|===