Module Values.OidcConfigInfoSource

Contains the OpenID Connect (OIDC) configuration information for Single Sign-On (SSO) authentication, including identity provider settings and client credentials.

Sourcetype nonrec t = {
  1. applicationName : GenericString.t option;
    (*

    The name of the OIDC application as registered with the identity provider.

    *)
  2. clientId : GenericString.t option;
    (*

    The OAuth client ID assigned by the identity provider for authentication requests.

    *)
  3. companyId : GenericString.t option;
    (*

    Custom identifier your end users will use to sign in with SSO.

    *)
  4. scopes : GenericString.t option;
    (*

    The OAuth scopes requested from the identity provider, which determine what user information is accessible (e.g., 'openid profile email').

    *)
  5. issuer : GenericString.t option;
    (*

    The issuer URL of the identity provider, which serves as the base URL for OIDC endpoints and configuration discovery.

    *)
  6. clientSecret : SensitiveString.t option;
    (*

    The OAuth client secret used to authenticate the application with the identity provider.

    *)
  7. secret : SensitiveString.t option;
    (*

    An additional secret credential used by the identity provider for authentication.

    *)
  8. redirectUrl : GenericString.t option;
    (*

    The callback URL where the identity provider redirects users after successful authentication. This URL must be registered with the identity provider.

    *)
  9. userId : GenericString.t option;
    (*

    The claim field from the OIDC token to use as the unique user identifier (e.g., 'email', 'sub', or a custom claim).

    *)
  10. customUsername : GenericString.t option;
    (*

    A custom field mapping to extract the username from the OIDC token when the standard username claim is insufficient.

    *)
  11. caCertificate : GenericString.t option;
    (*

    The X.509 CA certificate for validating SSL/TLS connections to the identity provider when using self-signed or enterprise certificates.

    *)
  12. applicationId : OidcConfigInfoApplicationIdInteger.t option;
    (*

    The unique identifier for the registered OIDC application. Valid range is 1-10.

    *)
  13. ssoTokenBufferMinutes : Integer.t option;
    (*

    The grace period in minutes before the SSO token expires when the system should proactively refresh the token to maintain seamless user access.

    *)
  14. extraAuthParams : GenericString.t option;
    (*

    Additional authentication parameters to include in the OIDC authorization request as a query string. Useful for provider-specific extensions.

    *)
}
Sourceval make : ?applicationName:GenericString.t -> ?clientId:GenericString.t -> ?companyId:GenericString.t -> ?scopes:GenericString.t -> ?issuer:GenericString.t -> ?clientSecret:SensitiveString.t -> ?secret:SensitiveString.t -> ?redirectUrl:GenericString.t -> ?userId:GenericString.t -> ?customUsername:GenericString.t -> ?caCertificate:GenericString.t -> ?applicationId:OidcConfigInfoApplicationIdInteger.t -> ?ssoTokenBufferMinutes:Integer.t -> ?extraAuthParams:GenericString.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Integer of OidcConfigInfoApplicationIdInteger.t | `String of GenericString.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t