OidcConfigInfo ¶

class OidcConfigInfo(TypedDict, closed=True):
    application_name: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The name of the OIDC application as registered with the identity provider.</p>"""
    client_id: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The OAuth client ID assigned by the identity provider for authentication requests.</p>"""
    company_id: "capo_wickr.types.generic_string.GenericString"
    """<p>Custom identifier your end users will use to sign in with SSO.</p>"""
    scopes: "capo_wickr.types.generic_string.GenericString"
    """<p>The OAuth scopes requested from the identity provider, which determine what user information is accessible (e.g., 'openid profile email').</p>"""
    issuer: "capo_wickr.types.generic_string.GenericString"
    """<p>The issuer URL of the identity provider, which serves as the base URL for OIDC endpoints and configuration discovery.</p>"""
    client_secret: NotRequired["capo_wickr.types.sensitive_string.SensitiveString"]
    """<p>The OAuth client secret used to authenticate the application with the identity provider.</p>"""
    secret: NotRequired["capo_wickr.types.sensitive_string.SensitiveString"]
    """<p>An additional secret credential used by the identity provider for authentication.</p>"""
    redirect_url: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The callback URL where the identity provider redirects users after successful authentication. This URL must be registered with the identity provider.</p>"""
    user_id: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The claim field from the OIDC token to use as the unique user identifier (e.g., 'email', 'sub', or a custom claim).</p>"""
    custom_username: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>A custom field mapping to extract the username from the OIDC token when the standard username claim is insufficient.</p>"""
    ca_certificate: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The X.509 CA certificate for validating SSL/TLS connections to the identity provider when using self-signed or enterprise certificates.</p>"""
    application_id: NotRequired["int"]
    """<p>The unique identifier for the registered OIDC application. Valid range is 1-10.</p>"""
    sso_token_buffer_minutes: NotRequired["int"]
    """<p>The grace period in minutes before the SSO token expires when the system should proactively refresh the token to maintain seamless user access.</p>"""
    extra_auth_params: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>Additional authentication parameters to include in the OIDC authorization request as a query string. Useful for provider-specific extensions.</p>"""