o-auth-json.md
-
oauthclientid: The client ID of the client application registered in the identity provider. -
oauthclientsecret: The client secret of the client application registered in the identity provider. -
oauthtokenurl: The endpoint to which token refresh requests are sent. The format for this depends on your provider. For examples, see the Keycloak and Okta documentation.If
oauthdiscoveryurlis not set: this parameter is only required for IDP valdiation ifoauthdiscoveryurl, but should also be set for JWT validation to support token refresh. -
oauthauthurl: The authorization endpoint used for single sign-on. For examples, see the Keycloak and Okta documentation. -
oauthdiscoveryurl: Also known as the OpenID Provider Configuration Document, this endpoint contains a list of all other endpoints supported by the IDP. If set, the other endpoints (such asoauthtokenurlandoauthauthurl) do not need to be specified. This parameter is only supported for Keycloak. For other identity providers like Okta, the endpoints must be set manually.If you set both
oauthdiscoveryurland another endpoint (likeoauthtokenurl),oauthdiscoveryurltakes precedence.This parameter is only required for IDP valdiation, but should also be set for JWT validation to support token refresh.
-
oauthscope: The requested OAuth scopes, delimited with spaces. These scopes define the extent of access to the resource server (in this case, Vertica) granted to the client by the access token. For details, see the OAuth documentation.
-
oauthvalidatehostname: Boolean, whether to verify the subjectAltName of the identity provider host. If enabled, the IP address or hostname must be set as the subjectAltName in its certificate. Hostname verification is enabled by default.
Unlike oauthaccesstoken or oauthrefreshtoken, which must be set programmatically by the client when they attempt to connect, the same oauthjsonconfig can be reused between connections to the database.