SPToIDPBinding Property

Specifies the IdP to SP binding to use.

Syntax

 samlspserver.getSPToIDPBinding([callback])
 samlspserver.setSPToIDPBinding( SPToIDPBinding, [callback])

Possible Values

  0 (csbtNone), 
  1 (csbtSOAP), 
  2 (csbtPAOS), 
  3 (csbtRedirect), 
  4 (csbtPOST), 
  5 (csbtArtifact)

Default Value

3

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 getSPToIDPBinding([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 setSPToIDPBinding([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

Specifies the binding (message exchange mechanism) used for communication with Identity Provider (IdP) that is actually used during the session.

To specify the preferred binding, use PreferredIDPToSPBinding.

Data Type

Integer