get_authorization Method

Gets the authorization string required to access the protected resource.

Syntax

def get_authorization() -> str: ...

Remarks

on_get_authorization performs several operations automatically depending on the value of client_profile. Please see the introduction section for the OpenID class for a detailed overview of the typical scenarios.

After authorization is complete user_details will be populated with the claims parsed from the ID token. This method also returns an authorization string. The authorization string grants access to additional resources as requested via the authorization_scope property. If access to another resource was requested the access token returned here may be set in the Authorization property of any other class (or passed as the value of the HTTP Authorization header).

get_user_info may be called after calling this method.

The following properties are applicable when calling this method:

• client_id (required)
• client_secret (required)
• server_auth_url (required - populated by get_discovery_doc.)
• server_token_url (required - populated by get_discovery_doc.)
• signer_cert_url (conditional - populated by get_discovery_doc. Required if signer_cert is not set.)
• signer_cert (conditional - required if signer_cert_url is not set.)
• authorization_scope
• client_profile
• grant_type
• params
• refresh_token
• return_url
• state
• timeout
• Display
• Prompt
• IDTokenHint
• LoginHint
• ResponseType