OidcClientConfig

public class OidcClientConfig : @unchecked Sendable

Configuration class for OIDC client.

  • OpenID configuration.

    Declaration

    Swift

    public var openId: OpenIdConfiguration?

  • Token refresh threshold in seconds.

    Declaration

    Swift

    public var refreshThreshold: Int64

  • Logger instance for logging.

    Declaration

    Swift

    public var logger: Logger

  • Storage delegate for storing tokens.

    Declaration

    Swift

    public var storage: StorageDelegate<Token>

  • Discovery endpoint URL.

    Declaration

    Swift

    public var discoveryEndpoint: String

  • Client ID for OIDC.

    Declaration

    Swift

    public var clientId: String

  • Set of scopes for OIDC.

    Declaration

    Swift

    public var scopes: Set<String>

  • Redirect URI for OIDC.

    Declaration

    Swift

    public var redirectUri: String

  • Login hint for OIDC.

    Declaration

    Swift

    public var loginHint: String?

  • State parameter for OIDC.

    Declaration

    Swift

    public var state: String?

  • Nonce parameter for OIDC.

    Declaration

    Swift

    public var nonce: String?

  • Display parameter for OIDC.

    Declaration

    Swift

    public var display: String?

  • Prompt parameter for OIDC.

    Declaration

    Swift

    public var prompt: String?

  • UI locales parameter for OIDC.

    Declaration

    Swift

    public var uiLocales: String?

  • ACR values parameter for OIDC.

    Declaration

    Swift

    public var acrValues: String?

  • Additional parameters for OIDC.

    Declaration

    Swift

    public var additionalParameters: [String : String]

  • HTTP client for making network requests.

    Declaration

    Swift

    public var httpClient: HttpClient?

  • Initializes a new OidcClientConfig instance.

    Declaration

    Swift

    public init()

  • Adds a scope to the set of scopes.

    Declaration

    Swift

    public func scope(_ scope: String)

    Parameters

    scope

    The scope to add.

  • Updates the agent with the provided configuration.

    Declaration

    Swift

    public func updateAgent<T>(_ agent: any Agent<T>, config: (T) -> Void = {_ in })

    Parameters

    agent

    The agent to update.
    config

    The configuration block for the agent.
  • oidcInitialize() Asynchronous

    Initializes the lazy properties to their default values.

    Declaration

    Swift

    public func oidcInitialize() async throws

  • Clones the current configuration.

    Declaration

    Swift

    public func clone() -> OidcClientConfig

    Return Value

    A new instance of OidcClientConfig with the same properties.