SecureBlackbox 2020 Node.js Edition

Questions / Feedback?

OutputType Property

Returns the SAML type of message being created.

Syntax

 samlwriter.getOutputType([callback])

Possible Values

  0 (cstyNone), 
  1 (cstyAssertionIDRequest), 
  2 (cstySubjectQuery), 
  3 (cstyAuthnQuery), 
  4 (cstyAttributeQuery), 
  5 (cstyAuthzDecisionQuery), 
  6 (cstyAuthnRequest), 
  7 (cstyManageNameIDRequest), 
  8 (cstyLogoutRequest), 
  9 (cstyNameIDMappingRequest), 
  10 (cstyArtifactResolve), 
  11 (cstyResponse)

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 getOutputType([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 setOutputType([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

Use this property to check the type of SAML message being created. This is the same value that was passed to CreateNew call.

Depending on the assigned type, use properties of class to tune up the parameters of the chosen message type. For example, if setting OutputType to cstyAuthnQuery, use AuthnQuery property to adjust context class references or comparison settings.

This property is read-only and not available at design time.

Data Type

Integer

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