GetAuthorization Method
Gets the authorization string required to access the protected resource.
Syntax
QString GetAuthorization();
Remarks
GetAuthorization performs several operations automatically depending on the value of ClientProfile. Please see the introduction section for the OpenID class for a detailed overview of the typical scenarios.
After authorization is complete UserDetails 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 AuthorizationScope 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).
GetUserInfo may be called after calling this method.
The following properties are applicable when calling this method:
- ClientId (required)
- ClientSecret (required)
- ServerAuthURL (required - populated by GetDiscoveryDoc.)
- ServerTokenURL (required - populated by GetDiscoveryDoc.)
- SignerCertURL (conditional - populated by GetDiscoveryDoc. Required if SignerCert is not set.)
- SignerCert (conditional - required if SignerCertURL is not set.)
- AuthorizationScope
- ClientProfile
- GrantType
- Params
- RefreshToken
- ReturnURL
- State
- Timeout
- Display
- Prompt
- IDTokenHint
- LoginHint
- ResponseType
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.