Module keycloak_oidc_api_client.models

Contains all the data models used in inputs/outputs

Sub-modules

• keycloak_oidc_api_client.models.error
• keycloak_oidc_api_client.models.mtls_endpoint_aliases
• keycloak_oidc_api_client.models.request_token
• keycloak_oidc_api_client.models.request_token_response
• keycloak_oidc_api_client.models.user_code_request
• keycloak_oidc_api_client.models.user_code_response
• keycloak_oidc_api_client.models.well_known

Classes

Error

class Error(
    error: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    error_description: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>
)

Attributes:

error (Union[Unset, str]): error_description (Union[Unset, str]):

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

error

error_description

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

MtlsEndpointAliases

class MtlsEndpointAliases(
    token_endpoint: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    revocation_endpoint: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    introspection_endpoint: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    device_authorization_endpoint: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    registration_endpoint: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    userinfo_endpoint: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    pushed_authorization_request_endpoint: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    backchannel_authentication_endpoint: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>
)

Attributes:

token_endpoint (Union[Unset, str]): revocation_endpoint (Union[Unset, str]): introspection_endpoint (Union[Unset, str]): device_authorization_endpoint (Union[Unset, str]): registration_endpoint (Union[Unset, str]): userinfo_endpoint (Union[Unset, str]): pushed_authorization_request_endpoint (Union[Unset, str]): backchannel_authentication_endpoint (Union[Unset, str]):

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

backchannel_authentication_endpoint

device_authorization_endpoint

introspection_endpoint

pushed_authorization_request_endpoint

registration_endpoint

revocation_endpoint

token_endpoint

userinfo_endpoint

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

RequestToken

class RequestToken(
    client_id: str,
    grant_type: str,
    device_code: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    client_secret: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    refresh_token: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>
)

Attributes:

client_id (str): grant_type (str): device_code (Union[Unset, str]): client_secret (Union[Unset, str]): refresh_token (Union[Unset, str]):

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

client_id

client_secret

device_code

grant_type

refresh_token

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

RequestTokenResponse

class RequestTokenResponse(
    access_token: str,
    refresh_token: str,
    expires_in: keycloak_oidc_api_client.types.Unset | int = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    refresh_expires_in: keycloak_oidc_api_client.types.Unset | int = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    token_type: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    id_token: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    not_before_policy: keycloak_oidc_api_client.types.Unset | int = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    session_state: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    scope: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>
)

Attributes:

access_token (str): refresh_token (str): expires_in (Union[Unset, int]): refresh_expires_in (Union[Unset, int]): token_type (Union[Unset, str]): id_token (Union[Unset, str]): not_before_policy (Union[Unset, int]): session_state (Union[Unset, str]): scope (Union[Unset, str]):

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

access_token

additional_keys

additional_properties

expires_in

id_token

not_before_policy

refresh_expires_in

refresh_token

scope

session_state

token_type

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UserCodeRequest

class UserCodeRequest(
    client_id: str,
    client_secret: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    scope: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>
)

Attributes:

client_id (str): client_secret (Union[Unset, str]): scope (Union[Unset, str]):

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

client_id

client_secret

scope

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UserCodeResponse

class UserCodeResponse(
    device_code: str,
    user_code: str,
    verification_uri: str,
    verification_uri_complete: str,
    expires_in: int,
    interval: int
)

Attributes:

device_code (str): a confidential code, where to poll the token user_code (str): an “authentication process id” verification_uri (str): where to redirect the user to the authentication process verification_uri_complete (str): The same of verification_uri, with the user_code in URI. Encode this in a QRCode expires_in (int): interval (int): for polling

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

device_code

expires_in

interval

user_code

verification_uri

verification_uri_complete

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

WellKnown

class WellKnown(
    issuer: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    authorization_endpoint: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    token_endpoint: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    introspection_endpoint: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    userinfo_endpoint: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    end_session_endpoint: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    frontchannel_logout_session_supported: keycloak_oidc_api_client.types.Unset | bool = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    frontchannel_logout_supported: keycloak_oidc_api_client.types.Unset | bool = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    jwks_uri: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    check_session_iframe: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    grant_types_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    acr_values_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    response_types_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    subject_types_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    id_token_signing_alg_values_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    id_token_encryption_alg_values_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    id_token_encryption_enc_values_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    userinfo_signing_alg_values_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    userinfo_encryption_alg_values_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    userinfo_encryption_enc_values_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    request_object_signing_alg_values_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    request_object_encryption_alg_values_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    request_object_encryption_enc_values_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    response_modes_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    registration_endpoint: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    token_endpoint_auth_methods_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    token_endpoint_auth_signing_alg_values_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    introspection_endpoint_auth_methods_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    introspection_endpoint_auth_signing_alg_values_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    authorization_signing_alg_values_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    authorization_encryption_alg_values_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    authorization_encryption_enc_values_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    claims_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    claim_types_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    claims_parameter_supported: keycloak_oidc_api_client.types.Unset | bool = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    scopes_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    request_parameter_supported: keycloak_oidc_api_client.types.Unset | bool = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    request_uri_parameter_supported: keycloak_oidc_api_client.types.Unset | bool = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    require_request_uri_registration: keycloak_oidc_api_client.types.Unset | bool = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    code_challenge_methods_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    tls_client_certificate_bound_access_tokens: keycloak_oidc_api_client.types.Unset | bool = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    revocation_endpoint: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    revocation_endpoint_auth_methods_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    revocation_endpoint_auth_signing_alg_values_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    backchannel_logout_supported: keycloak_oidc_api_client.types.Unset | bool = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    backchannel_logout_session_supported: keycloak_oidc_api_client.types.Unset | bool = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    device_authorization_endpoint: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    backchannel_token_delivery_modes_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    backchannel_authentication_endpoint: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    backchannel_authentication_request_signing_alg_values_supported: keycloak_oidc_api_client.types.Unset | list[str] = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    require_pushed_authorization_requests: keycloak_oidc_api_client.types.Unset | bool = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    pushed_authorization_request_endpoint: keycloak_oidc_api_client.types.Unset | str = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    mtls_endpoint_aliases: keycloak_oidc_api_client.types.Unset | ForwardRef('MtlsEndpointAliases') = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>,
    authorization_response_iss_parameter_supported: keycloak_oidc_api_client.types.Unset | bool = <keycloak_oidc_api_client.types.Unset object at 0x7f9a78819d30>
)

Attributes:

issuer (Union[Unset, str]): authorization_endpoint (Union[Unset, str]): token_endpoint (Union[Unset, str]): introspection_endpoint (Union[Unset, str]): userinfo_endpoint (Union[Unset, str]): end_session_endpoint (Union[Unset, str]): frontchannel_logout_session_supported (Union[Unset, bool]): frontchannel_logout_supported (Union[Unset, bool]): jwks_uri (Union[Unset, str]): check_session_iframe (Union[Unset, str]): grant_types_supported (Union[Unset, list[str]]): acr_values_supported (Union[Unset, list[str]]): response_types_supported (Union[Unset, list[str]]): subject_types_supported (Union[Unset, list[str]]): id_token_signing_alg_values_supported (Union[Unset, list[str]]): id_token_encryption_alg_values_supported (Union[Unset, list[str]]): id_token_encryption_enc_values_supported (Union[Unset, list[str]]): userinfo_signing_alg_values_supported (Union[Unset, list[str]]): userinfo_encryption_alg_values_supported (Union[Unset, list[str]]): userinfo_encryption_enc_values_supported (Union[Unset, list[str]]): request_object_signing_alg_values_supported (Union[Unset, list[str]]): request_object_encryption_alg_values_supported (Union[Unset, list[str]]): request_object_encryption_enc_values_supported (Union[Unset, list[str]]): response_modes_supported (Union[Unset, list[str]]): registration_endpoint (Union[Unset, str]): token_endpoint_auth_methods_supported (Union[Unset, list[str]]): token_endpoint_auth_signing_alg_values_supported (Union[Unset, list[str]]): introspection_endpoint_auth_methods_supported (Union[Unset, list[str]]): introspection_endpoint_auth_signing_alg_values_supported (Union[Unset, list[str]]): authorization_signing_alg_values_supported (Union[Unset, list[str]]): authorization_encryption_alg_values_supported (Union[Unset, list[str]]): authorization_encryption_enc_values_supported (Union[Unset, list[str]]): claims_supported (Union[Unset, list[str]]): claim_types_supported (Union[Unset, list[str]]): claims_parameter_supported (Union[Unset, bool]): scopes_supported (Union[Unset, list[str]]): request_parameter_supported (Union[Unset, bool]): request_uri_parameter_supported (Union[Unset, bool]): require_request_uri_registration (Union[Unset, bool]): code_challenge_methods_supported (Union[Unset, list[str]]): tls_client_certificate_bound_access_tokens (Union[Unset, bool]): revocation_endpoint (Union[Unset, str]): revocation_endpoint_auth_methods_supported (Union[Unset, list[str]]): revocation_endpoint_auth_signing_alg_values_supported (Union[Unset, list[str]]): backchannel_logout_supported (Union[Unset, bool]): backchannel_logout_session_supported (Union[Unset, bool]): device_authorization_endpoint (Union[Unset, str]): backchannel_token_delivery_modes_supported (Union[Unset, list[str]]): backchannel_authentication_endpoint (Union[Unset, str]): backchannel_authentication_request_signing_alg_values_supported (Union[Unset, list[str]]): require_pushed_authorization_requests (Union[Unset, bool]): pushed_authorization_request_endpoint (Union[Unset, str]): mtls_endpoint_aliases (Union[Unset, MtlsEndpointAliases]): authorization_response_iss_parameter_supported (Union[Unset, bool]):

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

acr_values_supported

additional_keys

additional_properties

authorization_encryption_alg_values_supported

authorization_encryption_enc_values_supported

authorization_endpoint

authorization_response_iss_parameter_supported

authorization_signing_alg_values_supported

backchannel_authentication_endpoint

backchannel_authentication_request_signing_alg_values_supported

backchannel_logout_session_supported

backchannel_logout_supported

backchannel_token_delivery_modes_supported

check_session_iframe

claim_types_supported

claims_parameter_supported

claims_supported

code_challenge_methods_supported

device_authorization_endpoint

end_session_endpoint

frontchannel_logout_session_supported

frontchannel_logout_supported

grant_types_supported

id_token_encryption_alg_values_supported

id_token_encryption_enc_values_supported

id_token_signing_alg_values_supported

introspection_endpoint

introspection_endpoint_auth_methods_supported

introspection_endpoint_auth_signing_alg_values_supported

issuer

jwks_uri

mtls_endpoint_aliases

pushed_authorization_request_endpoint

registration_endpoint

request_object_encryption_alg_values_supported

request_object_encryption_enc_values_supported

request_object_signing_alg_values_supported

request_parameter_supported

request_uri_parameter_supported

require_pushed_authorization_requests

require_request_uri_registration

response_modes_supported

response_types_supported

revocation_endpoint

revocation_endpoint_auth_methods_supported

revocation_endpoint_auth_signing_alg_values_supported

scopes_supported

subject_types_supported

tls_client_certificate_bound_access_tokens

token_endpoint

token_endpoint_auth_methods_supported

token_endpoint_auth_signing_alg_values_supported

userinfo_encryption_alg_values_supported

userinfo_encryption_enc_values_supported

userinfo_endpoint

userinfo_signing_alg_values_supported

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]