IPWorks Auth 2020 Node.js Edition

Questions / Feedback?

GetAuthorization Method

Gets the authorization string required to access the protected resource.

Syntax

openid.getAuthorization([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

'err' has 2 properties which hold detailed information:

err.code
err.message

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:

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Auth 2020 Node.js Edition - Version 20.0 [Build 8155]