AppendParam

Description

Appends a custom parameter to the token request body. Use this function with any supported grant type to send additional parameters required by the authorization server, such as scope, username, password, or vendor-specific parameters.

Applies to

TokenRequest object

Syntax

objectname.AppendParam ( string param, string value )

Argument

Description

objectname

A reference to the TokenRequest object in which you want to append the parameter.

param

A string specifying the parameter name.

value

A string specifying the parameter value.


Return value

Integer.

Returns 1 if it succeeds and -1 if an error occurs. If any argument's value is null, the method returns null.

Examples

The following example shows the use of the AppendParam function to add a custom parameter to a token request.

int li_return
string ls_param, ls_value 
TokenRequest lnv_TokenRequest

li_return = lnv_TokenRequest.appendparam(ls_param,ls_value)

For more examples of using AppendParam, see the section called “Supporting OAuth 2.0 Authorization Server”.

See also

ClearHeaders

GetHeader

GetHeaders

SetHeader

SetHeaders