IPWorks Auth 2020 Node.js Edition

Questions / Feedback?

AssertionVersion Property

The version of the assertion.

Syntax

 saml.getAssertionVersion([callback])
 saml.setAssertionVersion( assertionVersion, [callback])

Possible Values

  0 (svSAMLv11), 
  1 (svSAMLv20)

Default Value

0

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 getAssertionVersion([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 setAssertionVersion([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 version of the assertion. This may be set before calling GetAssertion. This will be populated after calling ParseAssertion. Possible values are:

0 (svSAMLv11 - default) SAML version 1.1
1 (svSAMLv20) SAML version 2.0

This property is not available at design time.

Data Type

Integer

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