Skip to content

StartDeviceAuthorizationResponse

Source code in docs_src/capo_sso_oidc/types/start_device_authorization_response.py
class StartDeviceAuthorizationResponse(TypedDict, closed=True):
    device_code: NotRequired["capo_sso_oidc.types.device_code.DeviceCode"]
    """<p>The short-lived code that is used by the device when polling for a session token.</p>"""
    user_code: NotRequired["capo_sso_oidc.types.user_code.UserCode"]
    """<p>A one-time user verification code. This is needed to authorize an in-use device.</p>"""
    verification_uri: NotRequired["capo_sso_oidc.types.uri.URI"]
    """<p>The URI of the verification page that takes the <code>userCode</code> to authorize the device.</p>"""
    verification_uri_complete: NotRequired["capo_sso_oidc.types.uri.URI"]
    """<p>An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the verification page and enters their code.</p>"""
    expires_in: "capo_sso_oidc.types.expiration_in_seconds.ExpirationInSeconds"
    """<p>Indicates the number of seconds in which the verification code will become invalid.</p>"""
    interval: "capo_sso_oidc.types.interval_in_seconds.IntervalInSeconds"
    """<p>Indicates the number of seconds the client must wait between attempts when polling for a session.</p>"""

device_code instance-attribute

device_code: NotRequired[DeviceCode]

The short-lived code that is used by the device when polling for a session token.

expires_in instance-attribute

expires_in: ExpirationInSeconds

Indicates the number of seconds in which the verification code will become invalid.

interval instance-attribute

Indicates the number of seconds the client must wait between attempts when polling for a session.

user_code instance-attribute

user_code: NotRequired[UserCode]

A one-time user verification code. This is needed to authorize an in-use device.

verification_uri instance-attribute

verification_uri: NotRequired[URI]

The URI of the verification page that takes the userCode to authorize the device.

verification_uri_complete instance-attribute

verification_uri_complete: NotRequired[URI]

An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the verification page and enters their code.