Skip to content

RegisterOidcConfigRequest

Source code in docs_src/capo_wickr/types/register_oidc_config_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class RegisterOidcConfigRequest(TypedDict, closed=True):
    network_id: "capo_wickr.types.network_id.NetworkId"
    """<p>The ID of the Wickr network for which OIDC will be configured.</p>"""
    company_id: "capo_wickr.types.generic_string.GenericString"
    """<p>Custom identifier your end users will use to sign in with SSO.</p>"""
    custom_username: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>A custom field mapping to extract the username from the OIDC token (optional). </p> <note> <p>The customUsername is only required if you use something other than email as the username field.</p> </note>"""
    extra_auth_params: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>Additional authentication parameters to include in the OIDC flow (optional).</p>"""
    issuer: "capo_wickr.types.generic_string.GenericString"
    """<p>The issuer URL of the OIDC provider (e.g., 'https://login.example.com').</p>"""
    scopes: "capo_wickr.types.generic_string.GenericString"
    """<p>The OAuth scopes to request from the OIDC provider (e.g., 'openid profile email').</p>"""
    secret: NotRequired["capo_wickr.types.sensitive_string.SensitiveString"]
    """<p>The client secret for authenticating with the OIDC provider (optional).</p>"""
    sso_token_buffer_minutes: NotRequired["int"]
    """<p>The buffer time in minutes before the SSO token expires to refresh it (optional).</p>"""
    user_id: NotRequired["capo_wickr.types.generic_string.GenericString"]
    """<p>Unique identifier provided by your identity provider to authenticate the access request. Also referred to as clientID.</p>"""

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]

A custom field mapping to extract the username from the OIDC token (optional).

The customUsername is only required if you use something other than email as the username field.

extra_auth_params instance-attribute 

extra_auth_params: NotRequired[GenericString]

Additional authentication parameters to include in the OIDC flow (optional).

issuer instance-attribute 

issuer: GenericString

The issuer URL of the OIDC provider (e.g., 'https://login.example.com').

network_id instance-attribute 

network_id: NetworkId

The ID of the Wickr network for which OIDC will be configured.

scopes instance-attribute 

scopes: GenericString

The OAuth scopes to request from the OIDC provider (e.g., 'openid profile email').

secret instance-attribute 

secret: NotRequired[SensitiveString]

The client secret for authenticating with the OIDC provider (optional).

sso_token_buffer_minutes instance-attribute 

sso_token_buffer_minutes: NotRequired[int]

The buffer time in minutes before the SSO token expires to refresh it (optional).

user_id instance-attribute 

user_id: NotRequired[GenericString]

Unique identifier provided by your identity provider to authenticate the access request. Also referred to as clientID.