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: 'str | Unset' = <keycloak_oidc_api_client.types.Unset object at 0x7f3d5a84da90>,
    error_description: 'str | Unset' = <keycloak_oidc_api_client.types.Unset object at 0x7f3d5a84da90>
)

Attributes:

error (str | Unset): error_description (str | Unset):

Static methods

from_dict

def from_dict(
    src_dict: 'Mapping[str, Any]'
) -> 'T'

Instance variables

additional_keys

additional_properties

error

error_description

Methods

to_dict

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

MtlsEndpointAliases

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

Attributes:

token_endpoint (str | Unset): revocation_endpoint (str | Unset): introspection_endpoint (str | Unset): device_authorization_endpoint (str | Unset): registration_endpoint (str | Unset): userinfo_endpoint (str | Unset): pushed_authorization_request_endpoint (str | Unset): backchannel_authentication_endpoint (str | Unset):

Static methods

from_dict

def from_dict(
    src_dict: 'Mapping[str, 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, Any]'

RequestToken

class RequestToken(
    client_id: 'str',
    grant_type: 'str',
    device_code: 'str | Unset' = <keycloak_oidc_api_client.types.Unset object at 0x7f3d5a84da90>,
    client_secret: 'str | Unset' = <keycloak_oidc_api_client.types.Unset object at 0x7f3d5a84da90>,
    refresh_token: 'str | Unset' = <keycloak_oidc_api_client.types.Unset object at 0x7f3d5a84da90>,
    username: 'str | Unset' = <keycloak_oidc_api_client.types.Unset object at 0x7f3d5a84da90>,
    password: 'str | Unset' = <keycloak_oidc_api_client.types.Unset object at 0x7f3d5a84da90>,
    scope: 'str | Unset' = <keycloak_oidc_api_client.types.Unset object at 0x7f3d5a84da90>
)

Attributes:

client_id (str): grant_type (str): device_code (str | Unset): client_secret (str | Unset): refresh_token (str | Unset): username (str | Unset): password (str | Unset): scope (str | Unset):

Static methods

from_dict

def from_dict(
    src_dict: 'Mapping[str, Any]'
) -> 'T'

Instance variables

additional_keys

additional_properties

client_id

client_secret

device_code

grant_type

password

refresh_token

scope

username

Methods

to_dict

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

RequestTokenResponse

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

Attributes:

access_token (str): refresh_token (str): expires_in (int | Unset): refresh_expires_in (int | Unset): token_type (str | Unset): id_token (str | Unset): not_before_policy (int | Unset): session_state (str | Unset): scope (str | Unset):

Static methods

from_dict

def from_dict(
    src_dict: 'Mapping[str, 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, Any]'

UserCodeRequest

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

Attributes:

client_id (str): client_secret (str | Unset): scope (str | Unset):

Static methods

from_dict

def from_dict(
    src_dict: 'Mapping[str, Any]'
) -> 'T'

Instance variables

additional_keys

additional_properties

client_id

client_secret

scope

Methods

to_dict

def to_dict(
    self
) -> 'dict[str, 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: 'Mapping[str, 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, Any]'

WellKnown

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

Attributes:

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

Static methods

from_dict

def from_dict(
    src_dict: 'Mapping[str, 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, Any]'