IPWorks Auth 2020 Node.js Edition

Questions / Feedback?

LocalSTS Property

The local Security Token Service (STS).

Syntax

 saml.getLocalSTS([callback])
 saml.setLocalSTS( localSTS, [callback])

Default Value

""

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 the getLocalSTS([callback]) 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.

The callback for the setLocalSTS([callback]) method is defined as:

function(err){ }

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

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property specifies the URL of the local Security Token Service(STS).

When AuthMode is set to 0 (camSharePointOnline) or 1 (camDynamicsCRM) if this is not specified, then the class will attempt to determine this value automatically by querying the UserRealm.

When AuthMode is set to 2 (camADFS) or 3 (camCustom) this property is required.

This property is not available at design time.

Data Type

String

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