PreferredSingleSignOnResponseBinding Property

Specifies preferred SSO response binding.

Syntax

 samlidpserver.getPreferredSingleSignOnResponseBinding([callback])
 samlidpserver.setPreferredSingleSignOnResponseBinding( preferredSingleSignOnResponseBinding, [callback])

Possible Values

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

Default Value

4

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 getPreferredSingleSignOnResponseBinding([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 setPreferredSingleSignOnResponseBinding([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 value is used by the Identity Provider (IdP) when the default binding is not specified in Service Provider's (SP) metadata file.

The binding is the mechanism of message exchange used by SAML requestors and responders.

Data Type

Integer