Skip to content

RegisterOidcConfigResponse

Source code in docs_src/capo_wickr/types/register_oidc_config_response.py
class RegisterOidcConfigResponse(TypedDict, closed=True):
    application_name: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The name of the registered OIDC application.</p>"""
    client_id: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The OAuth client ID assigned to the application.</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 configured for the application.</p>"""
    issuer: "capo_wickr.types.generic_string.GenericString"
    """<p>The issuer URL of the OIDC provider.</p>"""
    client_secret: NotRequired["capo_wickr.types.sensitive_string.SensitiveString"]
    """<p>The OAuth client secret for the application.</p>"""
    secret: NotRequired["capo_wickr.types.sensitive_string.SensitiveString"]
    """<p>The client secret for authenticating with the OIDC provider.</p>"""
    redirect_url: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The redirect URL configured for the OAuth flow.</p>"""
    user_id: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The claim field being used as the user identifier.</p>"""
    custom_username: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The custom field mapping used for extracting the username.</p>"""
    ca_certificate: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The CA certificate used for secure communication with the OIDC provider.</p>"""
    application_id: NotRequired["int"]
    """<p>The unique identifier for the registered OIDC application.</p>"""
    sso_token_buffer_minutes: NotRequired["int"]
    """<p>The buffer time in minutes before the SSO token expires.</p>"""
    extra_auth_params: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>The additional authentication parameters configured for the OIDC flow.</p>"""

application_id instance-attribute

application_id: NotRequired[int]

The unique identifier for the registered OIDC application.

application_name instance-attribute

application_name: NotRequired[GenericString]

The name of the registered OIDC application.

ca_certificate instance-attribute

ca_certificate: NotRequired[GenericString]

The CA certificate used for secure communication with the OIDC provider.

client_id instance-attribute

client_id: NotRequired[GenericString]

The OAuth client ID assigned to the application.

client_secret instance-attribute

client_secret: NotRequired[SensitiveString]

The OAuth client secret for the application.

company_id instance-attribute

company_id: GenericString

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

custom_username instance-attribute

custom_username: NotRequired[GenericString]

The custom field mapping used for extracting the username.

extra_auth_params instance-attribute

extra_auth_params: NotRequired[GenericString]

The additional authentication parameters configured for the OIDC flow.

issuer instance-attribute

issuer: GenericString

The issuer URL of the OIDC provider.

redirect_url instance-attribute

redirect_url: NotRequired[GenericString]

The redirect URL configured for the OAuth flow.

scopes instance-attribute

scopes: GenericString

The OAuth scopes configured for the application.

secret instance-attribute

secret: NotRequired[SensitiveString]

The client secret for authenticating with the OIDC provider.

sso_token_buffer_minutes instance-attribute

sso_token_buffer_minutes: NotRequired[int]

The buffer time in minutes before the SSO token expires.

user_id instance-attribute

user_id: NotRequired[GenericString]

The claim field being used as the user identifier.