OIDCIdentityProvider is a datatype for an OIDC identity provider.

Table: OIDCIdentityProvider

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 27, 2024
authenticationMethodAuthenticationMethodAuthyes The authentication method used. See AuthenticationMethodAuth.
authorizationEndpointstring  A URL to the endpoint a user should be redirected to when authorizing.
clientIdstringyes The unique identifier for the client.
clientSecretstringyes The password for the client.
debugbooleanyes Whether debugging is enabled.
defaultIdpbooleanyes Whether the identity provider is the default.
domains[string]yes The domains authorized by the OIDC identity providers.
federatedIdpstring  The Federated IdP.
groupsClaimstring  The name of the claim to interpret as the groups in LogScale. The value in the claim must be an array of strings. Optional. Defaults to humio-groups.
humioManagedbooleanyes Whether authentication is managed by LogScale.
idstringyes The unique identifier for the OIDC identity provider.
issuerstringyes The issuer of the OIDC authentication.
jwksEndpointstring  A URL to the JWKS endpoint for retrieving keys for validating tokens. Required.
lazyCreateUsersbooleanyes Whether to wait to create users until necessary.
namestringyes The name of the OIDC identity provider.
registrationEndpointstring  To use OIDC as a client, PUBLIC_URL must be set, LogScale must be registered as a client with your OpenID provider, and the provider must allow %PUBLIC_URL%/auth/oidc as a valid redirect endpoint for the client.
scopeClaimstring  The scope claim.
scopes[string]yes Comma-separated list of scopes to add in addition to the default requested scopes (openid, email, and profile).
tokenEndpointstring  A URL to the token endpoint used to exchange a authentication code to an access token. Required for clients.
tokenEndpointAuthMethodstringyes A URL to the token endpoint used to exchange a authentication code to an access token. Required for clients.
userClaimstringyes The name of the claim to interpret as username in LogScale. The value in the claim must be a string. Defaults to humio-user. Can be set to email if using emails as usernames.
userInfoEndpointstring  A URL to the user info endpoint used to retrieve user information from an access token.