SAMLWriter Class

Properties   Methods   Events   Config Settings   Errors  

The SAMLWriter class offers SAML message generation functions.

Syntax

SAMLWriter

Remarks

SAMLWriter provides means of serialization of SAML entities into valid SAML protocol messages. Together with SAMLReader, this class provides fine-grained access to the composition of SAML requests, responses, assertions, and statements. You can use it as part of your SAML client or SAML server implementation for creating individual SAML entities.

SAMLReader and SAMLWriter are independent of SAML server controls that are also included in SecureBlackbox, and are aimed at scenarios that require lower-level access to SAML functionality than that provided by the server controls.

SAMLWriter can create the following kinds of SAML messages:

• AssertionIDRequest
• SubjectQuery
• AuthnQuery
• AttributeQuery
• AuthzDecisionQuery
• AuthnRequest
• ManageNameIDRequest
• LogoutRequest
• NameIDMappingRequest
• ArtifactResolve
• Response

Please find below a quick-and-dirty example of the use of SAMLWriter class for creating a signed AuthnRequest message:

 
 Copy
  Samlwriter writer = new Samlwriter();

  // configuring general message properties
  writer.Destination = "http://destination-url.com";
  writer.IssueInstant = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ss.fffZ");
  writer.Issuer = "Value=https://issuer-url.com;Format=urn:oasis:names:tc:SAML:2.0:nameid-format:entity;IDType=Issuer";

  // configuring general AuthnRequest properties
  writer.AuthnRequest.IsPassive = false;
  writer.AuthnRequest.UseIsPassive = true;
  writer.AuthnRequest.ForceAuthn = true;
  writer.AuthnRequest.ProtocolBinding = "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST";
  writer.AuthnRequest.AssertionConsumerServiceURL = "https://assertion-consumer-url.com";
  writer.AuthnRequest.AttributeConsumingServiceIndex = 1;
  writer.AuthnRequest.NameIDPolicyAllowCreate = false;
  writer.AuthnRequest.NameIDPolicyFormat = "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent";
  writer.AuthnRequest.ConditionsNotBefore = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ss.fffZ");
  writer.AuthnRequest.ConditionsNotOnOrAfter = DateTime.UtcNow.AddMinutes(30).ToString("yyyy-MM-ddTHH:mm:ss.fffZ");

  // adjusting request conditions if required
  SAMLAssertionCondition cond = new SAMLAssertionCondition();
  cond.ConditionType = SAMLConditionTypes.csctOneTimeUse;
  writer.AuthnRequestConditions.Add(cond);

  // configuring signing properties
  Certificate certificate = new Certificate("C:\\Certs\\samlCert.pfx", "password");
  writer.Sign = true;
  writer.SigningCertificate = certificate;

  // creating the SAML entity of the required type
  writer.CreateNew((int)SamlwriterOutputTypes.cstyAuthnRequest);

  // adjusting low-level signature parameters
  writer.Config("SigDigestMethod=http://www.w3.org/2001/04/xmlenc#sha256");
  writer.Config("SigMethod=http://www.w3.org/2001/04/xmldsig-more#rsa-sha256");
            
  // signing the request and serializing it to XML
  string request = writer.Save();

 
 Copy
  <samlp:AuthnRequest 
    xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion" ID="53GhrzQ5f89fu214ANAR" Version="2.0" 
    IssueInstant="2021-12-15T10:39:31Z" Destination="http://destination-url.com" IsPassive="false" 
    ProtocolBinding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" 
    AssertionConsumerServiceURL="https://assertion-consumer-url.com" AttributeConsumingServiceIndex="1" 
    xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol">
    <saml:Issuer Format="urn:oasis:names:tc:SAML:2.0:nameid-format:entity">https://issuer-url.com</saml:Issuer>
    <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
      <ds:SignedInfo>
        <ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
        <ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/>
        <ds:Reference URI="#53GhrzQ5f89fu214ANAR">
          <ds:Transforms>
            <ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>
            <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
          </ds:Transforms>
          <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/><ds:DigestValue>+xhhgXtwYN0/r9h7WAwg=</ds:DigestValue>
        </ds:Reference>
      </ds:SignedInfo>
      <ds:SignatureValue>
        jfYeIq/z8D1tJZYbVqDMoqKpdrfGMj8/zI7gbUsJbECAr00cN34md2QG0mo4cOx7pny+5
        Tht7tUzqENHqcZdmlOcZc2JcJqokVxIcLEluFiWKlNjpexkXFQKzOC1peRfTZm8SQTqtP
        Cz8IknLUc6Scfml29PHmks1PxjJDteGb/+FggsZRTGZC3a05nvH3ayvHukPeHuHssx5dX
        nj0quT8salR6fdx6lAJo/AnDHzcfBNyxAMn+ebk5VOOgVD1L3PayvXib/maj8aVI2I5UT
        o4vmfybTWKzeS8DX9We7UV+4Xowwe647t1A912xLVub/e23A18Yf1V0PXC87kttTkA==
      </ds:SignatureValue>
      <ds:KeyInfo>
        <ds:X509Data><ds:X509Certificate>
          MIIEKDCCAxCgAwIBAgIFYA3A3gIwDQYJKoZIhvcNAQELBQAwfjELMAkGA1UEBhMCVVMxC
          zAJBgNVBAgTAk5DMRQwEgYDVQQHEwtDaGFwZWwgSGlsbDEiMCAGCSqGSIb3DQEJARMTc2
          FsZXNAbnNvZnR3YXJlLmNvbTEoMCYGA1UEAxMfU2VjdXJlQmxhY2tib3ggRGVtbyBDZXJ
          0aWZpY2F0ZTAeFw0xNzA5MDEwMDAwMDBaFw0yMjA5MDEwMDAwMDBaMH4xCzAJBgNVBAYT
          AlVTMQswCQYDVQQIEwJOQzEUMBIGA1UEBxMLQ2hhcGVsIEhpbGwxIjAgBgkqhkiG9w0BC
          QETE3NhbGVzQG5zb2Z0d2FyZS5jb20xKDAmBgNVBAMTH1NlY3VyZUJsYWNrYm94IERlbW
          8gQ2VydGlmaWNhdGUwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCfAVIcq9o
          eoIbw56LsPjxWsX3YGkqasBQzgQymhfcDZeSvFKFis8iqArGLTUUWOaImO5t2UmjIa+4n
          YP39hb9Z1r0CMy53p83oYbbZZ7qMeji0pMAufJHqKCN8t2HNWf2HE8S9UOU7R/UHdrSAN
          JitBKV9lSG9f450yWoGNwt35ZCsOp0zqtCgvkEvteGsz01R5DDjOccs3QNu25K/Sf27KP
          CYabS6A1ehYNY/G32qoKNJhu3DN4bWje57gBWi9WSfQ3tZUOV5q2ozaNJA78Wl4fXC6RB
          CaBh0GOwXeyZoH13LJdn+lqlCSMz024ImG4yFQEENbWvE9Elku8RYTn73AgMBAAGjgaww
          gakwHwYDVR0jBBgwFoAUmt/L7GI1SH36Sp8EUBxTwuzSgqMwHQYDVR0OBBYEFJrfy+xiN
          Uh9+kqfBFAcU8Ls0oKjMA8GA1UdEwEB/wQFMAMBAf8wDwYDVR0PAQH/BAUDAwDuADBFBg
          NVHSUEPjA8BggrBgEFBQcDAQYIKwYBBQUHAwIGCCsGAQUFBwMDBggrBgEFBQcDBAYIKwY
          BBQUHAwgGCCsGAQUFBwMJMA0GCSqGSIb3DQEBCwUAA4IBAQBovHBbMsW/k/5iuLQQqsYS
          ng5X2iy1W+5BRb1hz0MGnHGLqJWy1ty5+bTo6g/zvT65dXIPIexLkInEenYSy75Lthr6a
          ewUcvwfl1TYXjWlMD5Nm5pM9As71+XsGSdYGXoKohbEzbT6RDByjwR+yxtatqko7e1Eg6
          InNJRTRt7al/63FSPEgSCqOX6asDVDNZ83db0dOcoeaPEiDz3liE3+tYHtKXj5/qwTtYd
          aqBZxdJfuCKZveEFe1DO3/ayDvIvG9Eme+rEjntErF+Cw9a8ukesvDuT49cRE9oTs3O7f
          6LUbhCv5zJN+dTFr75NSdWdp4yvn3nK3i2udeMnTWK0U
        </ds:X509Certificate></ds:X509Data>
      </ds:KeyInfo>
    </ds:Signature>
    <samlp:NameIDPolicy Format="urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"/>
    <saml:Conditions NotBefore="2021-12-15T10:39:31Z" NotOnOrAfter="2021-12-15T11:09:31Z"><saml:OneTimeUse/></saml:Conditions>
  </samlp:AuthnRequest>

Note that you need to set the signing certificate before calling CreateNew.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

AddXMLHeader Property (SAMLWriter Class)

Controls the inclusion of an XML header in the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAddXMLHeader();
int SetAddXMLHeader(int bAddXMLHeader);

Unicode (Windows)
BOOL GetAddXMLHeader();
INT SetAddXMLHeader(BOOL bAddXMLHeader);

int secureblackbox_samlwriter_getaddxmlheader(void* lpObj);
int secureblackbox_samlwriter_setaddxmlheader(void* lpObj, int bAddXMLHeader);

bool GetAddXMLHeader();
int SetAddXMLHeader(bool bAddXMLHeader);

Default Value

FALSE

Remarks

Use this property to enable or disable inclusion of the XML header in the SAML message.

This property is not available at design time.

Data Type

Boolean

ArtifactEndpointIndex Property (SAMLWriter Class)

An accessor to the EndpointIndex entry of the artifact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetArtifactEndpointIndex();
int SetArtifactEndpointIndex(int iArtifactEndpointIndex);

Unicode (Windows)
INT GetArtifactEndpointIndex();
INT SetArtifactEndpointIndex(INT iArtifactEndpointIndex);

int secureblackbox_samlwriter_getartifactendpointindex(void* lpObj);
int secureblackbox_samlwriter_setartifactendpointindex(void* lpObj, int iArtifactEndpointIndex);

int GetArtifactEndpointIndex();
int SetArtifactEndpointIndex(int iArtifactEndpointIndex);

Default Value

0

Remarks

An accessor to the EndpointIndex entry of the artifact.

The EndpointIndex references a specific artifact resolution endpoint (IdP or SP) managed by the artifact issuer.

This property is not available at design time.

Data Type

Integer

ArtifactMessageHandle Property (SAMLWriter Class)

An accessor to the MessageHandle property of the artifact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetArtifactMessageHandle(char* &lpArtifactMessageHandle, int &lenArtifactMessageHandle);
int SetArtifactMessageHandle(const char* lpArtifactMessageHandle, int lenArtifactMessageHandle);

Unicode (Windows)
INT GetArtifactMessageHandle(LPSTR &lpArtifactMessageHandle, INT &lenArtifactMessageHandle);
INT SetArtifactMessageHandle(LPCSTR lpArtifactMessageHandle, INT lenArtifactMessageHandle);

int secureblackbox_samlwriter_getartifactmessagehandle(void* lpObj, char** lpArtifactMessageHandle, int* lenArtifactMessageHandle);
int secureblackbox_samlwriter_setartifactmessagehandle(void* lpObj, const char* lpArtifactMessageHandle, int lenArtifactMessageHandle);

QByteArray GetArtifactMessageHandle();
int SetArtifactMessageHandle(QByteArray qbaArtifactMessageHandle);

Remarks

An accessor to the MessageHandle property of the artifact.

A message handle is a unique reference to a SAML message that can be produced by the artifact issuer upon request.

This property is not available at design time.

Data Type

Byte Array

ArtifactRemainingArtifact Property (SAMLWriter Class)

Returns the contents of the artifact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetArtifactRemainingArtifact(char* &lpArtifactRemainingArtifact, int &lenArtifactRemainingArtifact);

Unicode (Windows)
INT GetArtifactRemainingArtifact(LPSTR &lpArtifactRemainingArtifact, INT &lenArtifactRemainingArtifact);

int secureblackbox_samlwriter_getartifactremainingartifact(void* lpObj, char** lpArtifactRemainingArtifact, int* lenArtifactRemainingArtifact);

QByteArray GetArtifactRemainingArtifact();

Remarks

Returns the contents of the artifact.

Check this property to access the encoded contents of the artifact. This property is updated internally from the parameters of the artifact.

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

Data Type

Byte Array

ArtifactSourceID Property (SAMLWriter Class)

An accessor to the SourceID property of the artifact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetArtifactSourceID(char* &lpArtifactSourceID, int &lenArtifactSourceID);
int SetArtifactSourceID(const char* lpArtifactSourceID, int lenArtifactSourceID);

Unicode (Windows)
INT GetArtifactSourceID(LPSTR &lpArtifactSourceID, INT &lenArtifactSourceID);
INT SetArtifactSourceID(LPCSTR lpArtifactSourceID, INT lenArtifactSourceID);

int secureblackbox_samlwriter_getartifactsourceid(void* lpObj, char** lpArtifactSourceID, int* lenArtifactSourceID);
int secureblackbox_samlwriter_setartifactsourceid(void* lpObj, const char* lpArtifactSourceID, int lenArtifactSourceID);

QByteArray GetArtifactSourceID();
int SetArtifactSourceID(QByteArray qbaArtifactSourceID);

Remarks

An accessor to the SourceID property of the artifact.

SourceID uniquely identifies the issuer of the artifact.

This property is not available at design time.

Data Type

Byte Array

ArtifactTypeCode Property (SAMLWriter Class)

The TypeCode property of the artifact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetArtifactTypeCode();
int SetArtifactTypeCode(int iArtifactTypeCode);

Unicode (Windows)
INT GetArtifactTypeCode();
INT SetArtifactTypeCode(INT iArtifactTypeCode);

int secureblackbox_samlwriter_getartifacttypecode(void* lpObj);
int secureblackbox_samlwriter_setartifacttypecode(void* lpObj, int iArtifactTypeCode);

int GetArtifactTypeCode();
int SetArtifactTypeCode(int iArtifactTypeCode);

Default Value

0

Remarks

The TypeCode field of the artifact.

The type code artifact parameter uniquely identifies the artifact format. Currently (as per SAML 2.0) the only type code of 4 is defined. This format assumes the presence of ArtifactRemainingArtifact, ArtifactSourceID, and ArtifactMessageHandle parameters.

This property is not available at design time.

Data Type

Integer

ArtifactURI Property (SAMLWriter Class)

An accessor to the URI property of the artifact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArtifactURI();
int SetArtifactURI(const char* lpszArtifactURI);

Unicode (Windows)
LPWSTR GetArtifactURI();
INT SetArtifactURI(LPCWSTR lpszArtifactURI);

char* secureblackbox_samlwriter_getartifacturi(void* lpObj);
int secureblackbox_samlwriter_setartifacturi(void* lpObj, const char* lpszArtifactURI);

QString GetArtifactURI();
int SetArtifactURI(QString qsArtifactURI);

Default Value

""

Remarks

An accessor to the URI property of the artifact.

The URI property contains the origin of the artifact.

This property is not available at design time.

Data Type

String

ArtifactResolveQuery Property (SAMLWriter Class)

Contains the artifact resolve query.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArtifactResolveQuery();
int SetArtifactResolveQuery(const char* lpszArtifactResolveQuery);

Unicode (Windows)
LPWSTR GetArtifactResolveQuery();
INT SetArtifactResolveQuery(LPCWSTR lpszArtifactResolveQuery);

char* secureblackbox_samlwriter_getartifactresolvequery(void* lpObj);
int secureblackbox_samlwriter_setartifactresolvequery(void* lpObj, const char* lpszArtifactResolveQuery);

QString GetArtifactResolveQuery();
int SetArtifactResolveQuery(QString qsArtifactResolveQuery);

Default Value

""

Remarks

Use this property to read or set the artifact resolve query.

This property is not available at design time.

Data Type

String

AssertionAttrCount Property (SAMLWriter Class)

The number of records in the AssertionAttr arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAssertionAttrCount();
int SetAssertionAttrCount(int iAssertionAttrCount);

Unicode (Windows)
INT GetAssertionAttrCount();
INT SetAssertionAttrCount(INT iAssertionAttrCount);

int secureblackbox_samlwriter_getassertionattrcount(void* lpObj);
int secureblackbox_samlwriter_setassertionattrcount(void* lpObj, int iAssertionAttrCount);

int GetAssertionAttrCount();
int SetAssertionAttrCount(int iAssertionAttrCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• AssertionAttrFriendlyName
• AssertionAttrName
• AssertionAttrNameFormat
• AssertionAttrStatementIndex
• AssertionAttrValues

The array indices start at 0 and end at AssertionAttrCount - 1.

This property is not available at design time.

Data Type

Integer

AssertionAttrFriendlyName Property (SAMLWriter Class)

Specifies the friendly name of the attribute Use this property to access or set the friendly name of a SAML attribute (e.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionAttrFriendlyName(int iAssertionAttrIndex);
int SetAssertionAttrFriendlyName(int iAssertionAttrIndex, const char* lpszAssertionAttrFriendlyName);

Unicode (Windows)
LPWSTR GetAssertionAttrFriendlyName(INT iAssertionAttrIndex);
INT SetAssertionAttrFriendlyName(INT iAssertionAttrIndex, LPCWSTR lpszAssertionAttrFriendlyName);

char* secureblackbox_samlwriter_getassertionattrfriendlyname(void* lpObj, int assertionattrindex);
int secureblackbox_samlwriter_setassertionattrfriendlyname(void* lpObj, int assertionattrindex, const char* lpszAssertionAttrFriendlyName);

QString GetAssertionAttrFriendlyName(int iAssertionAttrIndex);
int SetAssertionAttrFriendlyName(int iAssertionAttrIndex, QString qsAssertionAttrFriendlyName);

Default Value

""

Remarks

Specifies the friendly name of the attribute

Use this property to access or set the friendly name of a SAML attribute (e.g. givenName).

The AssertionAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAttrCount property.

This property is not available at design time.

Data Type

String

AssertionAttrName Property (SAMLWriter Class)

Specifies the name of the attribute.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionAttrName(int iAssertionAttrIndex);
int SetAssertionAttrName(int iAssertionAttrIndex, const char* lpszAssertionAttrName);

Unicode (Windows)
LPWSTR GetAssertionAttrName(INT iAssertionAttrIndex);
INT SetAssertionAttrName(INT iAssertionAttrIndex, LPCWSTR lpszAssertionAttrName);

char* secureblackbox_samlwriter_getassertionattrname(void* lpObj, int assertionattrindex);
int secureblackbox_samlwriter_setassertionattrname(void* lpObj, int assertionattrindex, const char* lpszAssertionAttrName);

QString GetAssertionAttrName(int iAssertionAttrIndex);
int SetAssertionAttrName(int iAssertionAttrIndex, QString qsAssertionAttrName);

Default Value

""

Remarks

Specifies the name of the attribute.

Use this property to read or set the formal name of the attribute (e.g. urn:oid:2.5.4.42).

The AssertionAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAttrCount property.

This property is not available at design time.

Data Type

String

AssertionAttrNameFormat Property (SAMLWriter Class)

Indicates the format used to reference the attribute.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionAttrNameFormat(int iAssertionAttrIndex);
int SetAssertionAttrNameFormat(int iAssertionAttrIndex, const char* lpszAssertionAttrNameFormat);

Unicode (Windows)
LPWSTR GetAssertionAttrNameFormat(INT iAssertionAttrIndex);
INT SetAssertionAttrNameFormat(INT iAssertionAttrIndex, LPCWSTR lpszAssertionAttrNameFormat);

char* secureblackbox_samlwriter_getassertionattrnameformat(void* lpObj, int assertionattrindex);
int secureblackbox_samlwriter_setassertionattrnameformat(void* lpObj, int assertionattrindex, const char* lpszAssertionAttrNameFormat);

QString GetAssertionAttrNameFormat(int iAssertionAttrIndex);
int SetAssertionAttrNameFormat(int iAssertionAttrIndex, QString qsAssertionAttrNameFormat);

Default Value

""

Remarks

Indicates the format used to reference the attribute.

This property specifies the format that is used to reference the attribute (e.g. urn:oasis:names:tc:SAML:2.0:attrname-format:uri).

The AssertionAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAttrCount property.

This property is not available at design time.

Data Type

String

AssertionAttrStatementIndex Property (SAMLWriter Class)

Contains the index of the statement the attribute corresponds to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAssertionAttrStatementIndex(int iAssertionAttrIndex);
int SetAssertionAttrStatementIndex(int iAssertionAttrIndex, int iAssertionAttrStatementIndex);

Unicode (Windows)
INT GetAssertionAttrStatementIndex(INT iAssertionAttrIndex);
INT SetAssertionAttrStatementIndex(INT iAssertionAttrIndex, INT iAssertionAttrStatementIndex);

int secureblackbox_samlwriter_getassertionattrstatementindex(void* lpObj, int assertionattrindex);
int secureblackbox_samlwriter_setassertionattrstatementindex(void* lpObj, int assertionattrindex, int iAssertionAttrStatementIndex);

int GetAssertionAttrStatementIndex(int iAssertionAttrIndex);
int SetAssertionAttrStatementIndex(int iAssertionAttrIndex, int iAssertionAttrStatementIndex);

Default Value

-1

Remarks

Contains the index of the statement the attribute corresponds to.

Use this property to read or set the index of the statement in the statement list that this attribute corresponds to.

The AssertionAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAttrCount property.

This property is not available at design time.

Data Type

Integer

AssertionAttrValues Property (SAMLWriter Class)

Contains a list of attribute values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionAttrValues(int iAssertionAttrIndex);
int SetAssertionAttrValues(int iAssertionAttrIndex, const char* lpszAssertionAttrValues);

Unicode (Windows)
LPWSTR GetAssertionAttrValues(INT iAssertionAttrIndex);
INT SetAssertionAttrValues(INT iAssertionAttrIndex, LPCWSTR lpszAssertionAttrValues);

char* secureblackbox_samlwriter_getassertionattrvalues(void* lpObj, int assertionattrindex);
int secureblackbox_samlwriter_setassertionattrvalues(void* lpObj, int assertionattrindex, const char* lpszAssertionAttrValues);

QString GetAssertionAttrValues(int iAssertionAttrIndex);
int SetAssertionAttrValues(int iAssertionAttrIndex, QString qsAssertionAttrValues);

Default Value

""

Remarks

Contains a list of attribute values.

Use this property to access or set the value(s) included with the attribute. The value contains a list of strings of ContentType=contentType;Value=value format, separated with CRLF.

The AssertionAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionAttrCount property.

This property is not available at design time.

Data Type

String

AssertionConditionCount Property (SAMLWriter Class)

The number of records in the AssertionCondition arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAssertionConditionCount();
int SetAssertionConditionCount(int iAssertionConditionCount);

Unicode (Windows)
INT GetAssertionConditionCount();
INT SetAssertionConditionCount(INT iAssertionConditionCount);

int secureblackbox_samlwriter_getassertionconditioncount(void* lpObj);
int secureblackbox_samlwriter_setassertionconditioncount(void* lpObj, int iAssertionConditionCount);

int GetAssertionConditionCount();
int SetAssertionConditionCount(int iAssertionConditionCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• AssertionConditionAudienceList
• AssertionConditionConditionType
• AssertionConditionProxyRestrictionCount

The array indices start at 0 and end at AssertionConditionCount - 1.

This property is not available at design time.

Data Type

Integer

AssertionConditionAudienceList Property (SAMLWriter Class)

An accessor to the Audience list parameter of an audience restriction condition.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionConditionAudienceList(int iAssertionConditionIndex);
int SetAssertionConditionAudienceList(int iAssertionConditionIndex, const char* lpszAssertionConditionAudienceList);

Unicode (Windows)
LPWSTR GetAssertionConditionAudienceList(INT iAssertionConditionIndex);
INT SetAssertionConditionAudienceList(INT iAssertionConditionIndex, LPCWSTR lpszAssertionConditionAudienceList);

char* secureblackbox_samlwriter_getassertionconditionaudiencelist(void* lpObj, int assertionconditionindex);
int secureblackbox_samlwriter_setassertionconditionaudiencelist(void* lpObj, int assertionconditionindex, const char* lpszAssertionConditionAudienceList);

QString GetAssertionConditionAudienceList(int iAssertionConditionIndex);
int SetAssertionConditionAudienceList(int iAssertionConditionIndex, QString qsAssertionConditionAudienceList);

Default Value

""

Remarks

An accessor to the Audience list parameter of an audience restriction condition.

Use this property to read or set a list of audiences included in the restriction. Each audience is represented by an URI. Provide multiple audiences by splitting them with CRLF separators.

The AssertionConditionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionConditionCount property.

This property is not available at design time.

Data Type

String

AssertionConditionConditionType Property (SAMLWriter Class)

Specifies a type of the condition object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAssertionConditionConditionType(int iAssertionConditionIndex);
int SetAssertionConditionConditionType(int iAssertionConditionIndex, int iAssertionConditionConditionType);

Unicode (Windows)
INT GetAssertionConditionConditionType(INT iAssertionConditionIndex);
INT SetAssertionConditionConditionType(INT iAssertionConditionIndex, INT iAssertionConditionConditionType);

CSCT_AUDIENCE_RESTRICTION(0), 
CSCT_ONE_TIME_USE(1), 
CSCT_PROXY_RESTRICTION(2)

int secureblackbox_samlwriter_getassertionconditionconditiontype(void* lpObj, int assertionconditionindex);
int secureblackbox_samlwriter_setassertionconditionconditiontype(void* lpObj, int assertionconditionindex, int iAssertionConditionConditionType);

int GetAssertionConditionConditionType(int iAssertionConditionIndex);
int SetAssertionConditionConditionType(int iAssertionConditionIndex, int iAssertionConditionConditionType);

Default Value

0

Remarks

Specifies a type of the condition object.

Use this property to check or specify a type of the condition object. This can be either an audience restriction, a one time use limitation, or a proxy restriction.

The AssertionConditionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionConditionCount property.

This property is not available at design time.

Data Type

Integer

AssertionConditionProxyRestrictionCount Property (SAMLWriter Class)

An accessor to the proxy restriction count element of the condition.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAssertionConditionProxyRestrictionCount(int iAssertionConditionIndex);
int SetAssertionConditionProxyRestrictionCount(int iAssertionConditionIndex, int iAssertionConditionProxyRestrictionCount);

Unicode (Windows)
INT GetAssertionConditionProxyRestrictionCount(INT iAssertionConditionIndex);
INT SetAssertionConditionProxyRestrictionCount(INT iAssertionConditionIndex, INT iAssertionConditionProxyRestrictionCount);

int secureblackbox_samlwriter_getassertionconditionproxyrestrictioncount(void* lpObj, int assertionconditionindex);
int secureblackbox_samlwriter_setassertionconditionproxyrestrictioncount(void* lpObj, int assertionconditionindex, int iAssertionConditionProxyRestrictionCount);

int GetAssertionConditionProxyRestrictionCount(int iAssertionConditionIndex);
int SetAssertionConditionProxyRestrictionCount(int iAssertionConditionIndex, int iAssertionConditionProxyRestrictionCount);

Default Value

0

Remarks

An accessor to the proxy restriction count element of the condition.

Use this setting to access or set the value of the proxy restriction count condition.

The AssertionConditionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionConditionCount property.

This property is not available at design time.

Data Type

Integer

AssertionCount Property (SAMLWriter Class)

Returns the number of assertions in the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAssertionCount();

Unicode (Windows)
INT GetAssertionCount();

int secureblackbox_samlwriter_getassertioncount(void* lpObj);

int GetAssertionCount();

Default Value

0

Remarks

This property returns the total number of assertions currently defined in the SAML message.

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

Data Type

Integer

AssertionIDRequestReferences Property (SAMLWriter Class)

Contains the References entry of the SAML assertion ID request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionIDRequestReferences();
int SetAssertionIDRequestReferences(const char* lpszAssertionIDRequestReferences);

Unicode (Windows)
LPWSTR GetAssertionIDRequestReferences();
INT SetAssertionIDRequestReferences(LPCWSTR lpszAssertionIDRequestReferences);

char* secureblackbox_samlwriter_getassertionidrequestreferences(void* lpObj);
int secureblackbox_samlwriter_setassertionidrequestreferences(void* lpObj, const char* lpszAssertionIDRequestReferences);

QString GetAssertionIDRequestReferences();
int SetAssertionIDRequestReferences(QString qsAssertionIDRequestReferences);

Default Value

""

Remarks

Contains the References entry of the SAML assertion ID request.

Use this property to read or specify the value of the References entry of the Assertion ID Request.

This property is not available at design time.

Data Type

String

AssertionInfoAdviceAssertionCount Property (SAMLWriter Class)

Contains the number of advice assertions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAssertionInfoAdviceAssertionCount();
int SetAssertionInfoAdviceAssertionCount(int iAssertionInfoAdviceAssertionCount);

Unicode (Windows)
INT GetAssertionInfoAdviceAssertionCount();
INT SetAssertionInfoAdviceAssertionCount(INT iAssertionInfoAdviceAssertionCount);

int secureblackbox_samlwriter_getassertioninfoadviceassertioncount(void* lpObj);
int secureblackbox_samlwriter_setassertioninfoadviceassertioncount(void* lpObj, int iAssertionInfoAdviceAssertionCount);

int GetAssertionInfoAdviceAssertionCount();
int SetAssertionInfoAdviceAssertionCount(int iAssertionInfoAdviceAssertionCount);

Default Value

0

Remarks

Contains the number of advice assertions.

Use this property to access the number of advice assertions.

This property is not available at design time.

Data Type

Integer

AssertionInfoAssertionType Property (SAMLWriter Class)

Specifies the type of the assertion.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAssertionInfoAssertionType();
int SetAssertionInfoAssertionType(int iAssertionInfoAssertionType);

Unicode (Windows)
INT GetAssertionInfoAssertionType();
INT SetAssertionInfoAssertionType(INT iAssertionInfoAssertionType);

CSAT_ASSERTION_IDREF(0), 
CSAT_ASSERTION_URIREF(1), 
CSAT_ASSERTION(2), 
CSAT_ENCRYPTED_ASSERTION(3)

int secureblackbox_samlwriter_getassertioninfoassertiontype(void* lpObj);
int secureblackbox_samlwriter_setassertioninfoassertiontype(void* lpObj, int iAssertionInfoAssertionType);

int GetAssertionInfoAssertionType();
int SetAssertionInfoAssertionType(int iAssertionInfoAssertionType);

Default Value

0

Remarks

Specifies the type of the assertion.

Use this property to check or set the type of the assertion.

This property is not available at design time.

Data Type

Integer

AssertionInfoChainValidationDetails Property (SAMLWriter Class)

The details of a certificate chain validation outcome.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAssertionInfoChainValidationDetails();

Unicode (Windows)
INT GetAssertionInfoChainValidationDetails();

int secureblackbox_samlwriter_getassertioninfochainvalidationdetails(void* lpObj);

int GetAssertionInfoChainValidationDetails();

Default Value

0

Remarks

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

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

Data Type

Integer

AssertionInfoChainValidationResult Property (SAMLWriter Class)

The outcome of a certificate chain validation routine.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAssertionInfoChainValidationResult();

Unicode (Windows)
INT GetAssertionInfoChainValidationResult();

CVT_VALID(0), 
CVT_VALID_BUT_UNTRUSTED(1), 
CVT_INVALID(2), 
CVT_CANT_BE_ESTABLISHED(3)

int secureblackbox_samlwriter_getassertioninfochainvalidationresult(void* lpObj);

int GetAssertionInfoChainValidationResult();

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

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

Data Type

Integer

AssertionInfoConditionsNotBefore Property (SAMLWriter Class)

Represents the Conditions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionInfoConditionsNotBefore();
int SetAssertionInfoConditionsNotBefore(const char* lpszAssertionInfoConditionsNotBefore);

Unicode (Windows)
LPWSTR GetAssertionInfoConditionsNotBefore();
INT SetAssertionInfoConditionsNotBefore(LPCWSTR lpszAssertionInfoConditionsNotBefore);

char* secureblackbox_samlwriter_getassertioninfoconditionsnotbefore(void* lpObj);
int secureblackbox_samlwriter_setassertioninfoconditionsnotbefore(void* lpObj, const char* lpszAssertionInfoConditionsNotBefore);

QString GetAssertionInfoConditionsNotBefore();
int SetAssertionInfoConditionsNotBefore(QString qsAssertionInfoConditionsNotBefore);

Default Value

""

Remarks

Represents the Conditions.NotBefore assertion property.

Use this property to get or set the Conditions.NotBefore property of the assertion.

This property is not available at design time.

Data Type

String

AssertionInfoConditionsNotOnOrAfter Property (SAMLWriter Class)

Represents the Conditions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionInfoConditionsNotOnOrAfter();
int SetAssertionInfoConditionsNotOnOrAfter(const char* lpszAssertionInfoConditionsNotOnOrAfter);

Unicode (Windows)
LPWSTR GetAssertionInfoConditionsNotOnOrAfter();
INT SetAssertionInfoConditionsNotOnOrAfter(LPCWSTR lpszAssertionInfoConditionsNotOnOrAfter);

char* secureblackbox_samlwriter_getassertioninfoconditionsnotonorafter(void* lpObj);
int secureblackbox_samlwriter_setassertioninfoconditionsnotonorafter(void* lpObj, const char* lpszAssertionInfoConditionsNotOnOrAfter);

QString GetAssertionInfoConditionsNotOnOrAfter();
int SetAssertionInfoConditionsNotOnOrAfter(QString qsAssertionInfoConditionsNotOnOrAfter);

Default Value

""

Remarks

Represents the Conditions.NotOnOrAfter assertion property.

Use this property to get or set the Conditions.NotOnOrAfter property of the assertion.

This property is not available at design time.

Data Type

String

AssertionInfoEncryptedContent Property (SAMLWriter Class)

Represents the encrypted assertion content.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionInfoEncryptedContent();
int SetAssertionInfoEncryptedContent(const char* lpszAssertionInfoEncryptedContent);

Unicode (Windows)
LPWSTR GetAssertionInfoEncryptedContent();
INT SetAssertionInfoEncryptedContent(LPCWSTR lpszAssertionInfoEncryptedContent);

char* secureblackbox_samlwriter_getassertioninfoencryptedcontent(void* lpObj);
int secureblackbox_samlwriter_setassertioninfoencryptedcontent(void* lpObj, const char* lpszAssertionInfoEncryptedContent);

QString GetAssertionInfoEncryptedContent();
int SetAssertionInfoEncryptedContent(QString qsAssertionInfoEncryptedContent);

Default Value

""

Remarks

Represents the encrypted assertion content.

Use this property to get or set the encrypted assertion content.

This property is not available at design time.

Data Type

String

AssertionInfoID Property (SAMLWriter Class)

Represents the ID of the assertion.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionInfoID();
int SetAssertionInfoID(const char* lpszAssertionInfoID);

Unicode (Windows)
LPWSTR GetAssertionInfoID();
INT SetAssertionInfoID(LPCWSTR lpszAssertionInfoID);

char* secureblackbox_samlwriter_getassertioninfoid(void* lpObj);
int secureblackbox_samlwriter_setassertioninfoid(void* lpObj, const char* lpszAssertionInfoID);

QString GetAssertionInfoID();
int SetAssertionInfoID(QString qsAssertionInfoID);

Default Value

""

Remarks

Represents the ID of the assertion.

Use this property to read or set the unique ID of the assertion.

This property is not available at design time.

Data Type

String

AssertionInfoIDRef Property (SAMLWriter Class)

Represents an ID reference value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionInfoIDRef();
int SetAssertionInfoIDRef(const char* lpszAssertionInfoIDRef);

Unicode (Windows)
LPWSTR GetAssertionInfoIDRef();
INT SetAssertionInfoIDRef(LPCWSTR lpszAssertionInfoIDRef);

char* secureblackbox_samlwriter_getassertioninfoidref(void* lpObj);
int secureblackbox_samlwriter_setassertioninfoidref(void* lpObj, const char* lpszAssertionInfoIDRef);

QString GetAssertionInfoIDRef();
int SetAssertionInfoIDRef(QString qsAssertionInfoIDRef);

Default Value

""

Remarks

Represents an ID reference value.

Use this property to read or set the ID reference value for assertions of csatAssertionIDRef type.

This property is not available at design time.

Data Type

String

AssertionInfoIssueInstant Property (SAMLWriter Class)

Contains the assertion issuance time stamp.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionInfoIssueInstant();
int SetAssertionInfoIssueInstant(const char* lpszAssertionInfoIssueInstant);

Unicode (Windows)
LPWSTR GetAssertionInfoIssueInstant();
INT SetAssertionInfoIssueInstant(LPCWSTR lpszAssertionInfoIssueInstant);

char* secureblackbox_samlwriter_getassertioninfoissueinstant(void* lpObj);
int secureblackbox_samlwriter_setassertioninfoissueinstant(void* lpObj, const char* lpszAssertionInfoIssueInstant);

QString GetAssertionInfoIssueInstant();
int SetAssertionInfoIssueInstant(QString qsAssertionInfoIssueInstant);

Default Value

""

Remarks

Contains the assertion issuance time stamp.

Use this property to check or set the assertion issuance time.

This property is not available at design time.

Data Type

String

AssertionInfoSignatureValidationResult Property (SAMLWriter Class)

The outcome of the cryptographic signature validation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAssertionInfoSignatureValidationResult();

Unicode (Windows)
INT GetAssertionInfoSignatureValidationResult();

SVT_VALID(0), 
SVT_UNKNOWN(1), 
SVT_CORRUPTED(2), 
SVT_SIGNER_NOT_FOUND(3), 
SVT_FAILURE(4)

int secureblackbox_samlwriter_getassertioninfosignaturevalidationresult(void* lpObj);

int GetAssertionInfoSignatureValidationResult();

Default Value

0

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

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

Data Type

Integer

AssertionInfoSigned Property (SAMLWriter Class)

Specifies whether the assertion is signed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAssertionInfoSigned();
int SetAssertionInfoSigned(int bAssertionInfoSigned);

Unicode (Windows)
BOOL GetAssertionInfoSigned();
INT SetAssertionInfoSigned(BOOL bAssertionInfoSigned);

int secureblackbox_samlwriter_getassertioninfosigned(void* lpObj);
int secureblackbox_samlwriter_setassertioninfosigned(void* lpObj, int bAssertionInfoSigned);

bool GetAssertionInfoSigned();
int SetAssertionInfoSigned(bool bAssertionInfoSigned);

Default Value

FALSE

Remarks

Specifies whether the assertion is signed.

Use this property to establish whether the assertion is signed.

This property is not available at design time.

Data Type

Boolean

AssertionInfoURIRef Property (SAMLWriter Class)

Represents an URI reference value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionInfoURIRef();
int SetAssertionInfoURIRef(const char* lpszAssertionInfoURIRef);

Unicode (Windows)
LPWSTR GetAssertionInfoURIRef();
INT SetAssertionInfoURIRef(LPCWSTR lpszAssertionInfoURIRef);

char* secureblackbox_samlwriter_getassertioninfouriref(void* lpObj);
int secureblackbox_samlwriter_setassertioninfouriref(void* lpObj, const char* lpszAssertionInfoURIRef);

QString GetAssertionInfoURIRef();
int SetAssertionInfoURIRef(QString qsAssertionInfoURIRef);

Default Value

""

Remarks

Represents an URI reference value.

Use this property to read or set the URI reference value for assertions of csatAssertionURIRef type.

This property is not available at design time.

Data Type

String

AssertionInfoValidationLog Property (SAMLWriter Class)

Contains the signing certificate's chain validation log.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionInfoValidationLog();

Unicode (Windows)
LPWSTR GetAssertionInfoValidationLog();

char* secureblackbox_samlwriter_getassertioninfovalidationlog(void* lpObj);

QString GetAssertionInfoValidationLog();

Default Value

""

Remarks

Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures.

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

Data Type

String

AssertionInfoVersion Property (SAMLWriter Class)

Specifies the SAML protocol version used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionInfoVersion();
int SetAssertionInfoVersion(const char* lpszAssertionInfoVersion);

Unicode (Windows)
LPWSTR GetAssertionInfoVersion();
INT SetAssertionInfoVersion(LPCWSTR lpszAssertionInfoVersion);

char* secureblackbox_samlwriter_getassertioninfoversion(void* lpObj);
int secureblackbox_samlwriter_setassertioninfoversion(void* lpObj, const char* lpszAssertionInfoVersion);

QString GetAssertionInfoVersion();
int SetAssertionInfoVersion(QString qsAssertionInfoVersion);

Default Value

""

Remarks

Specifies the SAML protocol version used.

This property specifies the SAML protocol version. The default value is 2.0.

This property is not available at design time.

Data Type

String

AssertionIssuer Property (SAMLWriter Class)

Specifies the assertion issuer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionIssuer();
int SetAssertionIssuer(const char* lpszAssertionIssuer);

Unicode (Windows)
LPWSTR GetAssertionIssuer();
INT SetAssertionIssuer(LPCWSTR lpszAssertionIssuer);

char* secureblackbox_samlwriter_getassertionissuer(void* lpObj);
int secureblackbox_samlwriter_setassertionissuer(void* lpObj, const char* lpszAssertionIssuer);

QString GetAssertionIssuer();
int SetAssertionIssuer(QString qsAssertionIssuer);

Default Value

""

Remarks

Use this property to provide the assertion issuer ID.

This property is not available at design time.

Data Type

String

AssertionStatementCount Property (SAMLWriter Class)

The number of records in the AssertionStatement arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAssertionStatementCount();
int SetAssertionStatementCount(int iAssertionStatementCount);

Unicode (Windows)
INT GetAssertionStatementCount();
INT SetAssertionStatementCount(INT iAssertionStatementCount);

int secureblackbox_samlwriter_getassertionstatementcount(void* lpObj);
int secureblackbox_samlwriter_setassertionstatementcount(void* lpObj, int iAssertionStatementCount);

int GetAssertionStatementCount();
int SetAssertionStatementCount(int iAssertionStatementCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• AssertionStatementAttributes
• AssertionStatementAuthnContextAuthenticatingAuthorities
• AssertionStatementAuthnContextChoice
• AssertionStatementAuthnContextClassRef
• AssertionStatementAuthnContextDecl
• AssertionStatementAuthnContextDeclRef
• AssertionStatementAuthnInstant
• AssertionStatementAuthnSessionIndex
• AssertionStatementAuthnSessionNotOnOrAfter
• AssertionStatementAuthnSubjectLocalityAddress
• AssertionStatementAuthnSubjectLocalityDNSName
• AssertionStatementAuthzActions
• AssertionStatementAuthzDecision
• AssertionStatementAuthzDecisionEvidence
• AssertionStatementAuthzDecisionResource
• AssertionStatementStatementType

The array indices start at 0 and end at AssertionStatementCount - 1.

This property is not available at design time.

Data Type

Integer

AssertionStatementAttributes Property (SAMLWriter Class)

Contains a list of statement attribute names.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionStatementAttributes(int iAssertionStatementIndex);
int SetAssertionStatementAttributes(int iAssertionStatementIndex, const char* lpszAssertionStatementAttributes);

Unicode (Windows)
LPWSTR GetAssertionStatementAttributes(INT iAssertionStatementIndex);
INT SetAssertionStatementAttributes(INT iAssertionStatementIndex, LPCWSTR lpszAssertionStatementAttributes);

char* secureblackbox_samlwriter_getassertionstatementattributes(void* lpObj, int assertionstatementindex);
int secureblackbox_samlwriter_setassertionstatementattributes(void* lpObj, int assertionstatementindex, const char* lpszAssertionStatementAttributes);

QString GetAssertionStatementAttributes(int iAssertionStatementIndex);
int SetAssertionStatementAttributes(int iAssertionStatementIndex, QString qsAssertionStatementAttributes);

Default Value

""

Remarks

Contains a list of statement attribute names.

Use this property to access the set of names of assertion attributes, separated by CRLF.

The AssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementAuthnContextAuthenticatingAuthorities Property (SAMLWriter Class)

Contains the list of authenticating authorities.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionStatementAuthnContextAuthenticatingAuthorities(int iAssertionStatementIndex);
int SetAssertionStatementAuthnContextAuthenticatingAuthorities(int iAssertionStatementIndex, const char* lpszAssertionStatementAuthnContextAuthenticatingAuthorities);

Unicode (Windows)
LPWSTR GetAssertionStatementAuthnContextAuthenticatingAuthorities(INT iAssertionStatementIndex);
INT SetAssertionStatementAuthnContextAuthenticatingAuthorities(INT iAssertionStatementIndex, LPCWSTR lpszAssertionStatementAuthnContextAuthenticatingAuthorities);

char* secureblackbox_samlwriter_getassertionstatementauthncontextauthenticatingauthorities(void* lpObj, int assertionstatementindex);
int secureblackbox_samlwriter_setassertionstatementauthncontextauthenticatingauthorities(void* lpObj, int assertionstatementindex, const char* lpszAssertionStatementAuthnContextAuthenticatingAuthorities);

QString GetAssertionStatementAuthnContextAuthenticatingAuthorities(int iAssertionStatementIndex);
int SetAssertionStatementAuthnContextAuthenticatingAuthorities(int iAssertionStatementIndex, QString qsAssertionStatementAuthnContextAuthenticatingAuthorities);

Default Value

""

Remarks

Contains the list of authenticating authorities.

Use this property to access the list of URIs of authenticating authorities (IdP entity IDs).

The AssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementAuthnContextChoice Property (SAMLWriter Class)

Specifies the authentication context choice variant.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionStatementAuthnContextChoice(int iAssertionStatementIndex);
int SetAssertionStatementAuthnContextChoice(int iAssertionStatementIndex, const char* lpszAssertionStatementAuthnContextChoice);

Unicode (Windows)
LPWSTR GetAssertionStatementAuthnContextChoice(INT iAssertionStatementIndex);
INT SetAssertionStatementAuthnContextChoice(INT iAssertionStatementIndex, LPCWSTR lpszAssertionStatementAuthnContextChoice);

char* secureblackbox_samlwriter_getassertionstatementauthncontextchoice(void* lpObj, int assertionstatementindex);
int secureblackbox_samlwriter_setassertionstatementauthncontextchoice(void* lpObj, int assertionstatementindex, const char* lpszAssertionStatementAuthnContextChoice);

QString GetAssertionStatementAuthnContextChoice(int iAssertionStatementIndex);
int SetAssertionStatementAuthnContextChoice(int iAssertionStatementIndex, QString qsAssertionStatementAuthnContextChoice);

Default Value

""

Remarks

Specifies the authentication context choice variant.

Use this property to set the authentication context choice variant. The currently supported values are v1 and v2. If this setting is left empty, the v1 variant is assumed.

The AssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementAuthnContextClassRef Property (SAMLWriter Class)

Indicates the authentication contexts class reference.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionStatementAuthnContextClassRef(int iAssertionStatementIndex);
int SetAssertionStatementAuthnContextClassRef(int iAssertionStatementIndex, const char* lpszAssertionStatementAuthnContextClassRef);

Unicode (Windows)
LPWSTR GetAssertionStatementAuthnContextClassRef(INT iAssertionStatementIndex);
INT SetAssertionStatementAuthnContextClassRef(INT iAssertionStatementIndex, LPCWSTR lpszAssertionStatementAuthnContextClassRef);

char* secureblackbox_samlwriter_getassertionstatementauthncontextclassref(void* lpObj, int assertionstatementindex);
int secureblackbox_samlwriter_setassertionstatementauthncontextclassref(void* lpObj, int assertionstatementindex, const char* lpszAssertionStatementAuthnContextClassRef);

QString GetAssertionStatementAuthnContextClassRef(int iAssertionStatementIndex);
int SetAssertionStatementAuthnContextClassRef(int iAssertionStatementIndex, QString qsAssertionStatementAuthnContextClassRef);

Default Value

""

Remarks

Indicates the authentication contexts class reference.

Use this property to get or set the authentication contexts class reference attribute.

The AssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementAuthnContextDecl Property (SAMLWriter Class)

Specifies the authentication contexts declaration.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionStatementAuthnContextDecl(int iAssertionStatementIndex);
int SetAssertionStatementAuthnContextDecl(int iAssertionStatementIndex, const char* lpszAssertionStatementAuthnContextDecl);

Unicode (Windows)
LPWSTR GetAssertionStatementAuthnContextDecl(INT iAssertionStatementIndex);
INT SetAssertionStatementAuthnContextDecl(INT iAssertionStatementIndex, LPCWSTR lpszAssertionStatementAuthnContextDecl);

char* secureblackbox_samlwriter_getassertionstatementauthncontextdecl(void* lpObj, int assertionstatementindex);
int secureblackbox_samlwriter_setassertionstatementauthncontextdecl(void* lpObj, int assertionstatementindex, const char* lpszAssertionStatementAuthnContextDecl);

QString GetAssertionStatementAuthnContextDecl(int iAssertionStatementIndex);
int SetAssertionStatementAuthnContextDecl(int iAssertionStatementIndex, QString qsAssertionStatementAuthnContextDecl);

Default Value

""

Remarks

Specifies the authentication contexts declaration.

Use this property to access or set the declaration element of the authentication context.

The AssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementAuthnContextDeclRef Property (SAMLWriter Class)

Specifies the authentication contexts declaration reference.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionStatementAuthnContextDeclRef(int iAssertionStatementIndex);
int SetAssertionStatementAuthnContextDeclRef(int iAssertionStatementIndex, const char* lpszAssertionStatementAuthnContextDeclRef);

Unicode (Windows)
LPWSTR GetAssertionStatementAuthnContextDeclRef(INT iAssertionStatementIndex);
INT SetAssertionStatementAuthnContextDeclRef(INT iAssertionStatementIndex, LPCWSTR lpszAssertionStatementAuthnContextDeclRef);

char* secureblackbox_samlwriter_getassertionstatementauthncontextdeclref(void* lpObj, int assertionstatementindex);
int secureblackbox_samlwriter_setassertionstatementauthncontextdeclref(void* lpObj, int assertionstatementindex, const char* lpszAssertionStatementAuthnContextDeclRef);

QString GetAssertionStatementAuthnContextDeclRef(int iAssertionStatementIndex);
int SetAssertionStatementAuthnContextDeclRef(int iAssertionStatementIndex, QString qsAssertionStatementAuthnContextDeclRef);

Default Value

""

Remarks

Specifies the authentication contexts declaration reference.

Use this property to get or set the declaration reference of the authentication context.

The AssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementAuthnInstant Property (SAMLWriter Class)

Specifies the authentication event timestamp.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionStatementAuthnInstant(int iAssertionStatementIndex);
int SetAssertionStatementAuthnInstant(int iAssertionStatementIndex, const char* lpszAssertionStatementAuthnInstant);

Unicode (Windows)
LPWSTR GetAssertionStatementAuthnInstant(INT iAssertionStatementIndex);
INT SetAssertionStatementAuthnInstant(INT iAssertionStatementIndex, LPCWSTR lpszAssertionStatementAuthnInstant);

char* secureblackbox_samlwriter_getassertionstatementauthninstant(void* lpObj, int assertionstatementindex);
int secureblackbox_samlwriter_setassertionstatementauthninstant(void* lpObj, int assertionstatementindex, const char* lpszAssertionStatementAuthnInstant);

QString GetAssertionStatementAuthnInstant(int iAssertionStatementIndex);
int SetAssertionStatementAuthnInstant(int iAssertionStatementIndex, QString qsAssertionStatementAuthnInstant);

Default Value

""

Remarks

Specifies the authentication event timestamp.

Use this property to read or set the moment in time the authentication event took place.

The AssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementAuthnSessionIndex Property (SAMLWriter Class)

Contains the authentication session index.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionStatementAuthnSessionIndex(int iAssertionStatementIndex);
int SetAssertionStatementAuthnSessionIndex(int iAssertionStatementIndex, const char* lpszAssertionStatementAuthnSessionIndex);

Unicode (Windows)
LPWSTR GetAssertionStatementAuthnSessionIndex(INT iAssertionStatementIndex);
INT SetAssertionStatementAuthnSessionIndex(INT iAssertionStatementIndex, LPCWSTR lpszAssertionStatementAuthnSessionIndex);

char* secureblackbox_samlwriter_getassertionstatementauthnsessionindex(void* lpObj, int assertionstatementindex);
int secureblackbox_samlwriter_setassertionstatementauthnsessionindex(void* lpObj, int assertionstatementindex, const char* lpszAssertionStatementAuthnSessionIndex);

QString GetAssertionStatementAuthnSessionIndex(int iAssertionStatementIndex);
int SetAssertionStatementAuthnSessionIndex(int iAssertionStatementIndex, QString qsAssertionStatementAuthnSessionIndex);

Default Value

""

Remarks

Contains the authentication session index.

Use this property to access or set the authentication session index.

The AssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementAuthnSessionNotOnOrAfter Property (SAMLWriter Class)

Maps to the SessionNotOnOrAfter parameter of the authentication statement.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionStatementAuthnSessionNotOnOrAfter(int iAssertionStatementIndex);
int SetAssertionStatementAuthnSessionNotOnOrAfter(int iAssertionStatementIndex, const char* lpszAssertionStatementAuthnSessionNotOnOrAfter);

Unicode (Windows)
LPWSTR GetAssertionStatementAuthnSessionNotOnOrAfter(INT iAssertionStatementIndex);
INT SetAssertionStatementAuthnSessionNotOnOrAfter(INT iAssertionStatementIndex, LPCWSTR lpszAssertionStatementAuthnSessionNotOnOrAfter);

char* secureblackbox_samlwriter_getassertionstatementauthnsessionnotonorafter(void* lpObj, int assertionstatementindex);
int secureblackbox_samlwriter_setassertionstatementauthnsessionnotonorafter(void* lpObj, int assertionstatementindex, const char* lpszAssertionStatementAuthnSessionNotOnOrAfter);

QString GetAssertionStatementAuthnSessionNotOnOrAfter(int iAssertionStatementIndex);
int SetAssertionStatementAuthnSessionNotOnOrAfter(int iAssertionStatementIndex, QString qsAssertionStatementAuthnSessionNotOnOrAfter);

Default Value

""

Remarks

Maps to the SessionNotOnOrAfter parameter of the authentication statement.

Use this property to access or set the SessionNotOnOrAfter parameter of the authentication statement.

The AssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementAuthnSubjectLocalityAddress Property (SAMLWriter Class)

Specifies the authentication subjects address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionStatementAuthnSubjectLocalityAddress(int iAssertionStatementIndex);
int SetAssertionStatementAuthnSubjectLocalityAddress(int iAssertionStatementIndex, const char* lpszAssertionStatementAuthnSubjectLocalityAddress);

Unicode (Windows)
LPWSTR GetAssertionStatementAuthnSubjectLocalityAddress(INT iAssertionStatementIndex);
INT SetAssertionStatementAuthnSubjectLocalityAddress(INT iAssertionStatementIndex, LPCWSTR lpszAssertionStatementAuthnSubjectLocalityAddress);

char* secureblackbox_samlwriter_getassertionstatementauthnsubjectlocalityaddress(void* lpObj, int assertionstatementindex);
int secureblackbox_samlwriter_setassertionstatementauthnsubjectlocalityaddress(void* lpObj, int assertionstatementindex, const char* lpszAssertionStatementAuthnSubjectLocalityAddress);

QString GetAssertionStatementAuthnSubjectLocalityAddress(int iAssertionStatementIndex);
int SetAssertionStatementAuthnSubjectLocalityAddress(int iAssertionStatementIndex, QString qsAssertionStatementAuthnSubjectLocalityAddress);

Default Value

""

Remarks

Specifies the authentication subjects address.

Use this property to specify the address parameter of the authentication subjects locality.

The AssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementAuthnSubjectLocalityDNSName Property (SAMLWriter Class)

Maps to the authentication subjects DNS name parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionStatementAuthnSubjectLocalityDNSName(int iAssertionStatementIndex);
int SetAssertionStatementAuthnSubjectLocalityDNSName(int iAssertionStatementIndex, const char* lpszAssertionStatementAuthnSubjectLocalityDNSName);

Unicode (Windows)
LPWSTR GetAssertionStatementAuthnSubjectLocalityDNSName(INT iAssertionStatementIndex);
INT SetAssertionStatementAuthnSubjectLocalityDNSName(INT iAssertionStatementIndex, LPCWSTR lpszAssertionStatementAuthnSubjectLocalityDNSName);

char* secureblackbox_samlwriter_getassertionstatementauthnsubjectlocalitydnsname(void* lpObj, int assertionstatementindex);
int secureblackbox_samlwriter_setassertionstatementauthnsubjectlocalitydnsname(void* lpObj, int assertionstatementindex, const char* lpszAssertionStatementAuthnSubjectLocalityDNSName);

QString GetAssertionStatementAuthnSubjectLocalityDNSName(int iAssertionStatementIndex);
int SetAssertionStatementAuthnSubjectLocalityDNSName(int iAssertionStatementIndex, QString qsAssertionStatementAuthnSubjectLocalityDNSName);

Default Value

""

Remarks

Maps to the authentication subjects DNS name parameter.

Use this property to access or set the authentication subjects DNS name locality parameter.

The AssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementAuthzActions Property (SAMLWriter Class)

Provides access to the list of actions of the authorization statement.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionStatementAuthzActions(int iAssertionStatementIndex);
int SetAssertionStatementAuthzActions(int iAssertionStatementIndex, const char* lpszAssertionStatementAuthzActions);

Unicode (Windows)
LPWSTR GetAssertionStatementAuthzActions(INT iAssertionStatementIndex);
INT SetAssertionStatementAuthzActions(INT iAssertionStatementIndex, LPCWSTR lpszAssertionStatementAuthzActions);

char* secureblackbox_samlwriter_getassertionstatementauthzactions(void* lpObj, int assertionstatementindex);
int secureblackbox_samlwriter_setassertionstatementauthzactions(void* lpObj, int assertionstatementindex, const char* lpszAssertionStatementAuthzActions);

QString GetAssertionStatementAuthzActions(int iAssertionStatementIndex);
int SetAssertionStatementAuthzActions(int iAssertionStatementIndex, QString qsAssertionStatementAuthzActions);

Default Value

""

Remarks

Provides access to the list of actions of the authorization statement.

Use this property to read or set the actions of the authorization statement. Actions are represented as a list of Namespace=namespace;Value=Value strings, separated with CRLFs.

The AssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementAuthzDecision Property (SAMLWriter Class)

Specifies the authorization decision.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAssertionStatementAuthzDecision(int iAssertionStatementIndex);
int SetAssertionStatementAuthzDecision(int iAssertionStatementIndex, int iAssertionStatementAuthzDecision);

Unicode (Windows)
INT GetAssertionStatementAuthzDecision(INT iAssertionStatementIndex);
INT SetAssertionStatementAuthzDecision(INT iAssertionStatementIndex, INT iAssertionStatementAuthzDecision);

CSADN_PERMIT(0), 
CSADN_DENY(1), 
CSADN_INDETERMINATE(2)

int secureblackbox_samlwriter_getassertionstatementauthzdecision(void* lpObj, int assertionstatementindex);
int secureblackbox_samlwriter_setassertionstatementauthzdecision(void* lpObj, int assertionstatementindex, int iAssertionStatementAuthzDecision);

int GetAssertionStatementAuthzDecision(int iAssertionStatementIndex);
int SetAssertionStatementAuthzDecision(int iAssertionStatementIndex, int iAssertionStatementAuthzDecision);

Default Value

0

Remarks

Specifies the authorization decision.

Use this property to check or set the authorization decision. This can be one of Permit, Deny, or Indeterminate.

The AssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

Integer

AssertionStatementAuthzDecisionEvidence Property (SAMLWriter Class)

Manages the authorization decision statement evidence parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionStatementAuthzDecisionEvidence(int iAssertionStatementIndex);
int SetAssertionStatementAuthzDecisionEvidence(int iAssertionStatementIndex, const char* lpszAssertionStatementAuthzDecisionEvidence);

Unicode (Windows)
LPWSTR GetAssertionStatementAuthzDecisionEvidence(INT iAssertionStatementIndex);
INT SetAssertionStatementAuthzDecisionEvidence(INT iAssertionStatementIndex, LPCWSTR lpszAssertionStatementAuthzDecisionEvidence);

char* secureblackbox_samlwriter_getassertionstatementauthzdecisionevidence(void* lpObj, int assertionstatementindex);
int secureblackbox_samlwriter_setassertionstatementauthzdecisionevidence(void* lpObj, int assertionstatementindex, const char* lpszAssertionStatementAuthzDecisionEvidence);

QString GetAssertionStatementAuthzDecisionEvidence(int iAssertionStatementIndex);
int SetAssertionStatementAuthzDecisionEvidence(int iAssertionStatementIndex, QString qsAssertionStatementAuthzDecisionEvidence);

Default Value

""

Remarks

Manages the authorization decision statement evidence parameter.

Use this property to read or set the authorization decision statement evidence parameter.

The AssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementAuthzDecisionResource Property (SAMLWriter Class)

Specifies the authorization decision statement resource parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionStatementAuthzDecisionResource(int iAssertionStatementIndex);
int SetAssertionStatementAuthzDecisionResource(int iAssertionStatementIndex, const char* lpszAssertionStatementAuthzDecisionResource);

Unicode (Windows)
LPWSTR GetAssertionStatementAuthzDecisionResource(INT iAssertionStatementIndex);
INT SetAssertionStatementAuthzDecisionResource(INT iAssertionStatementIndex, LPCWSTR lpszAssertionStatementAuthzDecisionResource);

char* secureblackbox_samlwriter_getassertionstatementauthzdecisionresource(void* lpObj, int assertionstatementindex);
int secureblackbox_samlwriter_setassertionstatementauthzdecisionresource(void* lpObj, int assertionstatementindex, const char* lpszAssertionStatementAuthzDecisionResource);

QString GetAssertionStatementAuthzDecisionResource(int iAssertionStatementIndex);
int SetAssertionStatementAuthzDecisionResource(int iAssertionStatementIndex, QString qsAssertionStatementAuthzDecisionResource);

Default Value

""

Remarks

Specifies the authorization decision statement resource parameter.

Use this property to access or set the resource parameter of the authorization statement.

The AssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

String

AssertionStatementStatementType Property (SAMLWriter Class)

Specifies the assertion statement type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAssertionStatementStatementType(int iAssertionStatementIndex);
int SetAssertionStatementStatementType(int iAssertionStatementIndex, int iAssertionStatementStatementType);

Unicode (Windows)
INT GetAssertionStatementStatementType(INT iAssertionStatementIndex);
INT SetAssertionStatementStatementType(INT iAssertionStatementIndex, INT iAssertionStatementStatementType);

CSAST_AUTHN(0), 
CSAST_ATTRIBUTE(1), 
CSAST_AUTHZ_DECISION(2)

int secureblackbox_samlwriter_getassertionstatementstatementtype(void* lpObj, int assertionstatementindex);
int secureblackbox_samlwriter_setassertionstatementstatementtype(void* lpObj, int assertionstatementindex, int iAssertionStatementStatementType);

int GetAssertionStatementStatementType(int iAssertionStatementIndex);
int SetAssertionStatementStatementType(int iAssertionStatementIndex, int iAssertionStatementStatementType);

Default Value

0

Remarks

Specifies the assertion statement type.

This property specifies the assertion statement type. A statement can carry an authentication assertion, an attribute assertion, or an authorization decision assertion.

The AssertionStatementIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionStatementCount property.

This property is not available at design time.

Data Type

Integer

AssertionSubjectConfirmationCount Property (SAMLWriter Class)

The number of records in the AssertionSubjectConfirmation arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAssertionSubjectConfirmationCount();
int SetAssertionSubjectConfirmationCount(int iAssertionSubjectConfirmationCount);

Unicode (Windows)
INT GetAssertionSubjectConfirmationCount();
INT SetAssertionSubjectConfirmationCount(INT iAssertionSubjectConfirmationCount);

int secureblackbox_samlwriter_getassertionsubjectconfirmationcount(void* lpObj);
int secureblackbox_samlwriter_setassertionsubjectconfirmationcount(void* lpObj, int iAssertionSubjectConfirmationCount);

int GetAssertionSubjectConfirmationCount();
int SetAssertionSubjectConfirmationCount(int iAssertionSubjectConfirmationCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• AssertionSubjectConfirmationDataAddress
• AssertionSubjectConfirmationDataInResponseTo
• AssertionSubjectConfirmationDataNotBefore
• AssertionSubjectConfirmationDataNotOnOrAfter
• AssertionSubjectConfirmationDataRecipient
• AssertionSubjectConfirmationDataType
• AssertionSubjectConfirmationID
• AssertionSubjectConfirmationMethod

The array indices start at 0 and end at AssertionSubjectConfirmationCount - 1.

This property is not available at design time.

Data Type

Integer

AssertionSubjectConfirmationDataAddress Property (SAMLWriter Class)

Contains the address enabled for presenting assertions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionSubjectConfirmationDataAddress(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationDataAddress(int iAssertionSubjectConfirmationIndex, const char* lpszAssertionSubjectConfirmationDataAddress);

Unicode (Windows)
LPWSTR GetAssertionSubjectConfirmationDataAddress(INT iAssertionSubjectConfirmationIndex);
INT SetAssertionSubjectConfirmationDataAddress(INT iAssertionSubjectConfirmationIndex, LPCWSTR lpszAssertionSubjectConfirmationDataAddress);

char* secureblackbox_samlwriter_getassertionsubjectconfirmationdataaddress(void* lpObj, int assertionsubjectconfirmationindex);
int secureblackbox_samlwriter_setassertionsubjectconfirmationdataaddress(void* lpObj, int assertionsubjectconfirmationindex, const char* lpszAssertionSubjectConfirmationDataAddress);

QString GetAssertionSubjectConfirmationDataAddress(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationDataAddress(int iAssertionSubjectConfirmationIndex, QString qsAssertionSubjectConfirmationDataAddress);

Default Value

""

Remarks

Contains the address enabled for presenting assertions.

Use this property to specify the network address or location from which the subject confirmation should be issued. This optional element can be used to restrict the possibilities of an attacker to steal the assertion and present it from another IP address.

The AssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionSubjectConfirmationCount property.

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationDataInResponseTo Property (SAMLWriter Class)

The ID of the SAML message in response to which the assertion is issued.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionSubjectConfirmationDataInResponseTo(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationDataInResponseTo(int iAssertionSubjectConfirmationIndex, const char* lpszAssertionSubjectConfirmationDataInResponseTo);

Unicode (Windows)
LPWSTR GetAssertionSubjectConfirmationDataInResponseTo(INT iAssertionSubjectConfirmationIndex);
INT SetAssertionSubjectConfirmationDataInResponseTo(INT iAssertionSubjectConfirmationIndex, LPCWSTR lpszAssertionSubjectConfirmationDataInResponseTo);

char* secureblackbox_samlwriter_getassertionsubjectconfirmationdatainresponseto(void* lpObj, int assertionsubjectconfirmationindex);
int secureblackbox_samlwriter_setassertionsubjectconfirmationdatainresponseto(void* lpObj, int assertionsubjectconfirmationindex, const char* lpszAssertionSubjectConfirmationDataInResponseTo);

QString GetAssertionSubjectConfirmationDataInResponseTo(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationDataInResponseTo(int iAssertionSubjectConfirmationIndex, QString qsAssertionSubjectConfirmationDataInResponseTo);

Default Value

""

Remarks

The ID of the SAML message in response to which the assertion is issued.

This property specifies the ID of the SAML message in response to which the assertion is issued.

The AssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionSubjectConfirmationCount property.

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationDataNotBefore Property (SAMLWriter Class)

Time moment before which the subject cannot be confirmed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionSubjectConfirmationDataNotBefore(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationDataNotBefore(int iAssertionSubjectConfirmationIndex, const char* lpszAssertionSubjectConfirmationDataNotBefore);

Unicode (Windows)
LPWSTR GetAssertionSubjectConfirmationDataNotBefore(INT iAssertionSubjectConfirmationIndex);
INT SetAssertionSubjectConfirmationDataNotBefore(INT iAssertionSubjectConfirmationIndex, LPCWSTR lpszAssertionSubjectConfirmationDataNotBefore);

char* secureblackbox_samlwriter_getassertionsubjectconfirmationdatanotbefore(void* lpObj, int assertionsubjectconfirmationindex);
int secureblackbox_samlwriter_setassertionsubjectconfirmationdatanotbefore(void* lpObj, int assertionsubjectconfirmationindex, const char* lpszAssertionSubjectConfirmationDataNotBefore);

QString GetAssertionSubjectConfirmationDataNotBefore(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationDataNotBefore(int iAssertionSubjectConfirmationIndex, QString qsAssertionSubjectConfirmationDataNotBefore);

Default Value

""

Remarks

Time moment before which the subject cannot be confirmed.

This property specifies the time before which the subject cannot be confirmed.

The AssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionSubjectConfirmationCount property.

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationDataNotOnOrAfter Property (SAMLWriter Class)

Limits the time until which the subject can be confirmed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionSubjectConfirmationDataNotOnOrAfter(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationDataNotOnOrAfter(int iAssertionSubjectConfirmationIndex, const char* lpszAssertionSubjectConfirmationDataNotOnOrAfter);

Unicode (Windows)
LPWSTR GetAssertionSubjectConfirmationDataNotOnOrAfter(INT iAssertionSubjectConfirmationIndex);
INT SetAssertionSubjectConfirmationDataNotOnOrAfter(INT iAssertionSubjectConfirmationIndex, LPCWSTR lpszAssertionSubjectConfirmationDataNotOnOrAfter);

char* secureblackbox_samlwriter_getassertionsubjectconfirmationdatanotonorafter(void* lpObj, int assertionsubjectconfirmationindex);
int secureblackbox_samlwriter_setassertionsubjectconfirmationdatanotonorafter(void* lpObj, int assertionsubjectconfirmationindex, const char* lpszAssertionSubjectConfirmationDataNotOnOrAfter);

QString GetAssertionSubjectConfirmationDataNotOnOrAfter(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationDataNotOnOrAfter(int iAssertionSubjectConfirmationIndex, QString qsAssertionSubjectConfirmationDataNotOnOrAfter);

Default Value

""

Remarks

Limits the time until which the subject can be confirmed.

This property specifies the time on (or after) which the subject cannot be confirmed.

The AssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionSubjectConfirmationCount property.

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationDataRecipient Property (SAMLWriter Class)

The URI of the entity or the location of the resource to which the assertion should be presented.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionSubjectConfirmationDataRecipient(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationDataRecipient(int iAssertionSubjectConfirmationIndex, const char* lpszAssertionSubjectConfirmationDataRecipient);

Unicode (Windows)
LPWSTR GetAssertionSubjectConfirmationDataRecipient(INT iAssertionSubjectConfirmationIndex);
INT SetAssertionSubjectConfirmationDataRecipient(INT iAssertionSubjectConfirmationIndex, LPCWSTR lpszAssertionSubjectConfirmationDataRecipient);

char* secureblackbox_samlwriter_getassertionsubjectconfirmationdatarecipient(void* lpObj, int assertionsubjectconfirmationindex);
int secureblackbox_samlwriter_setassertionsubjectconfirmationdatarecipient(void* lpObj, int assertionsubjectconfirmationindex, const char* lpszAssertionSubjectConfirmationDataRecipient);

QString GetAssertionSubjectConfirmationDataRecipient(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationDataRecipient(int iAssertionSubjectConfirmationIndex, QString qsAssertionSubjectConfirmationDataRecipient);

Default Value

""

Remarks

The URI of the entity or the location of the resource to which the assertion should be presented.

This property specifies The URI of the entity or the location of the resource to which the assertion should be presented.

The AssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionSubjectConfirmationCount property.

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationDataType Property (SAMLWriter Class)

The type of data contained in the confirmation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionSubjectConfirmationDataType(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationDataType(int iAssertionSubjectConfirmationIndex, const char* lpszAssertionSubjectConfirmationDataType);

Unicode (Windows)
LPWSTR GetAssertionSubjectConfirmationDataType(INT iAssertionSubjectConfirmationIndex);
INT SetAssertionSubjectConfirmationDataType(INT iAssertionSubjectConfirmationIndex, LPCWSTR lpszAssertionSubjectConfirmationDataType);

char* secureblackbox_samlwriter_getassertionsubjectconfirmationdatatype(void* lpObj, int assertionsubjectconfirmationindex);
int secureblackbox_samlwriter_setassertionsubjectconfirmationdatatype(void* lpObj, int assertionsubjectconfirmationindex, const char* lpszAssertionSubjectConfirmationDataType);

QString GetAssertionSubjectConfirmationDataType(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationDataType(int iAssertionSubjectConfirmationIndex, QString qsAssertionSubjectConfirmationDataType);

Default Value

""

Remarks

The type of data contained in the confirmation.

Use this property to read or specify the type of confirmation data included in the object.

The AssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionSubjectConfirmationCount property.

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationID Property (SAMLWriter Class)

The identifier of the entity which can satisfy the subject confirmation requirements.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionSubjectConfirmationID(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationID(int iAssertionSubjectConfirmationIndex, const char* lpszAssertionSubjectConfirmationID);

Unicode (Windows)
LPWSTR GetAssertionSubjectConfirmationID(INT iAssertionSubjectConfirmationIndex);
INT SetAssertionSubjectConfirmationID(INT iAssertionSubjectConfirmationIndex, LPCWSTR lpszAssertionSubjectConfirmationID);

char* secureblackbox_samlwriter_getassertionsubjectconfirmationid(void* lpObj, int assertionsubjectconfirmationindex);
int secureblackbox_samlwriter_setassertionsubjectconfirmationid(void* lpObj, int assertionsubjectconfirmationindex, const char* lpszAssertionSubjectConfirmationID);

QString GetAssertionSubjectConfirmationID(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationID(int iAssertionSubjectConfirmationIndex, QString qsAssertionSubjectConfirmationID);

Default Value

""

Remarks

The identifier of the entity which can satisfy the subject confirmation requirements.

This property specifies the identifier of the entity which is expected to satisfy the subject confirmation requirements.

The AssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionSubjectConfirmationCount property.

This property is not available at design time.

Data Type

String

AssertionSubjectConfirmationMethod Property (SAMLWriter Class)

Specifies the mechanism to be used to confirm the subject.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionSubjectConfirmationMethod(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationMethod(int iAssertionSubjectConfirmationIndex, const char* lpszAssertionSubjectConfirmationMethod);

Unicode (Windows)
LPWSTR GetAssertionSubjectConfirmationMethod(INT iAssertionSubjectConfirmationIndex);
INT SetAssertionSubjectConfirmationMethod(INT iAssertionSubjectConfirmationIndex, LPCWSTR lpszAssertionSubjectConfirmationMethod);

char* secureblackbox_samlwriter_getassertionsubjectconfirmationmethod(void* lpObj, int assertionsubjectconfirmationindex);
int secureblackbox_samlwriter_setassertionsubjectconfirmationmethod(void* lpObj, int assertionsubjectconfirmationindex, const char* lpszAssertionSubjectConfirmationMethod);

QString GetAssertionSubjectConfirmationMethod(int iAssertionSubjectConfirmationIndex);
int SetAssertionSubjectConfirmationMethod(int iAssertionSubjectConfirmationIndex, QString qsAssertionSubjectConfirmationMethod);

Default Value

""

Remarks

Specifies the mechanism to be used to confirm the subject.

This property contains a URI reference that identifies the mechanism to be used to confirm the subject.

The AssertionSubjectConfirmationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AssertionSubjectConfirmationCount property.

This property is not available at design time.

Data Type

String

AssertionSubjectID Property (SAMLWriter Class)

Specifies the assertion subject ID.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionSubjectID();
int SetAssertionSubjectID(const char* lpszAssertionSubjectID);

Unicode (Windows)
LPWSTR GetAssertionSubjectID();
INT SetAssertionSubjectID(LPCWSTR lpszAssertionSubjectID);

char* secureblackbox_samlwriter_getassertionsubjectid(void* lpObj);
int secureblackbox_samlwriter_setassertionsubjectid(void* lpObj, const char* lpszAssertionSubjectID);

QString GetAssertionSubjectID();
int SetAssertionSubjectID(QString qsAssertionSubjectID);

Default Value

""

Remarks

Use this property to provide the assertion's subject SAML ID.

This property is not available at design time.

Data Type

String

AttrQueryAttrCount Property (SAMLWriter Class)

The number of records in the AttrQueryAttr arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttrQueryAttrCount();
int SetAttrQueryAttrCount(int iAttrQueryAttrCount);

Unicode (Windows)
INT GetAttrQueryAttrCount();
INT SetAttrQueryAttrCount(INT iAttrQueryAttrCount);

int secureblackbox_samlwriter_getattrqueryattrcount(void* lpObj);
int secureblackbox_samlwriter_setattrqueryattrcount(void* lpObj, int iAttrQueryAttrCount);

int GetAttrQueryAttrCount();
int SetAttrQueryAttrCount(int iAttrQueryAttrCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttrQueryAttrFriendlyName
• AttrQueryAttrName
• AttrQueryAttrNameFormat
• AttrQueryAttrStatementIndex
• AttrQueryAttrValues

The array indices start at 0 and end at AttrQueryAttrCount - 1.

This property is not available at design time.

Data Type

Integer

AttrQueryAttrFriendlyName Property (SAMLWriter Class)

Specifies the friendly name of the attribute Use this property to access or set the friendly name of a SAML attribute (e.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrQueryAttrFriendlyName(int iAttrQueryAttrIndex);
int SetAttrQueryAttrFriendlyName(int iAttrQueryAttrIndex, const char* lpszAttrQueryAttrFriendlyName);

Unicode (Windows)
LPWSTR GetAttrQueryAttrFriendlyName(INT iAttrQueryAttrIndex);
INT SetAttrQueryAttrFriendlyName(INT iAttrQueryAttrIndex, LPCWSTR lpszAttrQueryAttrFriendlyName);

char* secureblackbox_samlwriter_getattrqueryattrfriendlyname(void* lpObj, int attrqueryattrindex);
int secureblackbox_samlwriter_setattrqueryattrfriendlyname(void* lpObj, int attrqueryattrindex, const char* lpszAttrQueryAttrFriendlyName);

QString GetAttrQueryAttrFriendlyName(int iAttrQueryAttrIndex);
int SetAttrQueryAttrFriendlyName(int iAttrQueryAttrIndex, QString qsAttrQueryAttrFriendlyName);

Default Value

""

Remarks

Specifies the friendly name of the attribute

Use this property to access or set the friendly name of a SAML attribute (e.g. givenName).

The AttrQueryAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrQueryAttrCount property.

This property is not available at design time.

Data Type

String

AttrQueryAttrName Property (SAMLWriter Class)

Specifies the name of the attribute.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrQueryAttrName(int iAttrQueryAttrIndex);
int SetAttrQueryAttrName(int iAttrQueryAttrIndex, const char* lpszAttrQueryAttrName);

Unicode (Windows)
LPWSTR GetAttrQueryAttrName(INT iAttrQueryAttrIndex);
INT SetAttrQueryAttrName(INT iAttrQueryAttrIndex, LPCWSTR lpszAttrQueryAttrName);

char* secureblackbox_samlwriter_getattrqueryattrname(void* lpObj, int attrqueryattrindex);
int secureblackbox_samlwriter_setattrqueryattrname(void* lpObj, int attrqueryattrindex, const char* lpszAttrQueryAttrName);

QString GetAttrQueryAttrName(int iAttrQueryAttrIndex);
int SetAttrQueryAttrName(int iAttrQueryAttrIndex, QString qsAttrQueryAttrName);

Default Value

""

Remarks

Specifies the name of the attribute.

Use this property to read or set the formal name of the attribute (e.g. urn:oid:2.5.4.42).

The AttrQueryAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrQueryAttrCount property.

This property is not available at design time.

Data Type

String

AttrQueryAttrNameFormat Property (SAMLWriter Class)

Indicates the format used to reference the attribute.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrQueryAttrNameFormat(int iAttrQueryAttrIndex);
int SetAttrQueryAttrNameFormat(int iAttrQueryAttrIndex, const char* lpszAttrQueryAttrNameFormat);

Unicode (Windows)
LPWSTR GetAttrQueryAttrNameFormat(INT iAttrQueryAttrIndex);
INT SetAttrQueryAttrNameFormat(INT iAttrQueryAttrIndex, LPCWSTR lpszAttrQueryAttrNameFormat);

char* secureblackbox_samlwriter_getattrqueryattrnameformat(void* lpObj, int attrqueryattrindex);
int secureblackbox_samlwriter_setattrqueryattrnameformat(void* lpObj, int attrqueryattrindex, const char* lpszAttrQueryAttrNameFormat);

QString GetAttrQueryAttrNameFormat(int iAttrQueryAttrIndex);
int SetAttrQueryAttrNameFormat(int iAttrQueryAttrIndex, QString qsAttrQueryAttrNameFormat);

Default Value

""

Remarks

Indicates the format used to reference the attribute.

This property specifies the format that is used to reference the attribute (e.g. urn:oasis:names:tc:SAML:2.0:attrname-format:uri).

The AttrQueryAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrQueryAttrCount property.

This property is not available at design time.

Data Type

String

AttrQueryAttrStatementIndex Property (SAMLWriter Class)

Contains the index of the statement the attribute corresponds to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttrQueryAttrStatementIndex(int iAttrQueryAttrIndex);
int SetAttrQueryAttrStatementIndex(int iAttrQueryAttrIndex, int iAttrQueryAttrStatementIndex);

Unicode (Windows)
INT GetAttrQueryAttrStatementIndex(INT iAttrQueryAttrIndex);
INT SetAttrQueryAttrStatementIndex(INT iAttrQueryAttrIndex, INT iAttrQueryAttrStatementIndex);

int secureblackbox_samlwriter_getattrqueryattrstatementindex(void* lpObj, int attrqueryattrindex);
int secureblackbox_samlwriter_setattrqueryattrstatementindex(void* lpObj, int attrqueryattrindex, int iAttrQueryAttrStatementIndex);

int GetAttrQueryAttrStatementIndex(int iAttrQueryAttrIndex);
int SetAttrQueryAttrStatementIndex(int iAttrQueryAttrIndex, int iAttrQueryAttrStatementIndex);

Default Value

-1

Remarks

Contains the index of the statement the attribute corresponds to.

Use this property to read or set the index of the statement in the statement list that this attribute corresponds to.

The AttrQueryAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrQueryAttrCount property.

This property is not available at design time.

Data Type

Integer

AttrQueryAttrValues Property (SAMLWriter Class)

Contains a list of attribute values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrQueryAttrValues(int iAttrQueryAttrIndex);
int SetAttrQueryAttrValues(int iAttrQueryAttrIndex, const char* lpszAttrQueryAttrValues);

Unicode (Windows)
LPWSTR GetAttrQueryAttrValues(INT iAttrQueryAttrIndex);
INT SetAttrQueryAttrValues(INT iAttrQueryAttrIndex, LPCWSTR lpszAttrQueryAttrValues);

char* secureblackbox_samlwriter_getattrqueryattrvalues(void* lpObj, int attrqueryattrindex);
int secureblackbox_samlwriter_setattrqueryattrvalues(void* lpObj, int attrqueryattrindex, const char* lpszAttrQueryAttrValues);

QString GetAttrQueryAttrValues(int iAttrQueryAttrIndex);
int SetAttrQueryAttrValues(int iAttrQueryAttrIndex, QString qsAttrQueryAttrValues);

Default Value

""

Remarks

Contains a list of attribute values.

Use this property to access or set the value(s) included with the attribute. The value contains a list of strings of ContentType=contentType;Value=value format, separated with CRLF.

The AttrQueryAttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrQueryAttrCount property.

This property is not available at design time.

Data Type

String

AuthnQueryComparison Property (SAMLWriter Class)

Specifies the authentication context comparison method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnQueryComparison();
int SetAuthnQueryComparison(int iAuthnQueryComparison);

Unicode (Windows)
INT GetAuthnQueryComparison();
INT SetAuthnQueryComparison(INT iAuthnQueryComparison);

CACCT_NONE(0), 
CACCT_EXACT(1), 
CACCT_MINIMUM(2), 
CACCT_MAXIMUM(3), 
CACCT_BETTER(4)

int secureblackbox_samlwriter_getauthnquerycomparison(void* lpObj);
int secureblackbox_samlwriter_setauthnquerycomparison(void* lpObj, int iAuthnQueryComparison);

int GetAuthnQueryComparison();
int SetAuthnQueryComparison(int iAuthnQueryComparison);

Default Value

0

Remarks

Specifies the authentication context comparison method.

Use this property to access or set the authentication contexts comparison method (none, exact, minimum, maximum, or better).

This property is not available at design time.

Data Type

Integer

AuthnQueryContextClassRefs Property (SAMLWriter Class)

Specifies the context class reference.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnQueryContextClassRefs();
int SetAuthnQueryContextClassRefs(const char* lpszAuthnQueryContextClassRefs);

Unicode (Windows)
LPWSTR GetAuthnQueryContextClassRefs();
INT SetAuthnQueryContextClassRefs(LPCWSTR lpszAuthnQueryContextClassRefs);

char* secureblackbox_samlwriter_getauthnquerycontextclassrefs(void* lpObj);
int secureblackbox_samlwriter_setauthnquerycontextclassrefs(void* lpObj, const char* lpszAuthnQueryContextClassRefs);

QString GetAuthnQueryContextClassRefs();
int SetAuthnQueryContextClassRefs(QString qsAuthnQueryContextClassRefs);

Default Value

""

Remarks

Specifies the context class reference.

Use this property to access or set the authentication context class reference.

This property is not available at design time.

Data Type

String

AuthnQueryRefType Property (SAMLWriter Class)

Specifies the context reference type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnQueryRefType();
int SetAuthnQueryRefType(int iAuthnQueryRefType);

Unicode (Windows)
INT GetAuthnQueryRefType();
INT SetAuthnQueryRefType(INT iAuthnQueryRefType);

CACRT_UNKNOWN(0), 
CACRT_CLASS(1), 
CACRT_DECL(2)

int secureblackbox_samlwriter_getauthnqueryreftype(void* lpObj);
int secureblackbox_samlwriter_setauthnqueryreftype(void* lpObj, int iAuthnQueryRefType);

int GetAuthnQueryRefType();
int SetAuthnQueryRefType(int iAuthnQueryRefType);

Default Value

0

Remarks

Specifies the context reference type.

Use this property to access or set the authentication contexts reference type (class or declaration).

This property is not available at design time.

Data Type

Integer

AuthnQuerySessionIndex Property (SAMLWriter Class)

Specifies the index of the session to the authentication entity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnQuerySessionIndex();
int SetAuthnQuerySessionIndex(const char* lpszAuthnQuerySessionIndex);

Unicode (Windows)
LPWSTR GetAuthnQuerySessionIndex();
INT SetAuthnQuerySessionIndex(LPCWSTR lpszAuthnQuerySessionIndex);

char* secureblackbox_samlwriter_getauthnquerysessionindex(void* lpObj);
int secureblackbox_samlwriter_setauthnquerysessionindex(void* lpObj, const char* lpszAuthnQuerySessionIndex);

QString GetAuthnQuerySessionIndex();
int SetAuthnQuerySessionIndex(QString qsAuthnQuerySessionIndex);

Default Value

""

Remarks

Specifies the index of the session to the authentication entity.

Use this property to access or set the index of the session to the authentication entity.

This property is not available at design time.

Data Type

String

AuthnRequestAssertionConsumerServiceIndex Property (SAMLWriter Class)

Specifies the assertion consumer service index.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestAssertionConsumerServiceIndex();
int SetAuthnRequestAssertionConsumerServiceIndex(int iAuthnRequestAssertionConsumerServiceIndex);

Unicode (Windows)
INT GetAuthnRequestAssertionConsumerServiceIndex();
INT SetAuthnRequestAssertionConsumerServiceIndex(INT iAuthnRequestAssertionConsumerServiceIndex);

int secureblackbox_samlwriter_getauthnrequestassertionconsumerserviceindex(void* lpObj);
int secureblackbox_samlwriter_setauthnrequestassertionconsumerserviceindex(void* lpObj, int iAuthnRequestAssertionConsumerServiceIndex);

int GetAuthnRequestAssertionConsumerServiceIndex();
int SetAuthnRequestAssertionConsumerServiceIndex(int iAuthnRequestAssertionConsumerServiceIndex);

Default Value

0

Remarks

Specifies the assertion consumer service index.

Use this property to access or set the location index to which the response has to be returned.

This property is not available at design time.

Data Type

Integer

AuthnRequestAssertionConsumerServiceURL Property (SAMLWriter Class)

Specifies the assertion consumer service URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnRequestAssertionConsumerServiceURL();
int SetAuthnRequestAssertionConsumerServiceURL(const char* lpszAuthnRequestAssertionConsumerServiceURL);

Unicode (Windows)
LPWSTR GetAuthnRequestAssertionConsumerServiceURL();
INT SetAuthnRequestAssertionConsumerServiceURL(LPCWSTR lpszAuthnRequestAssertionConsumerServiceURL);

char* secureblackbox_samlwriter_getauthnrequestassertionconsumerserviceurl(void* lpObj);
int secureblackbox_samlwriter_setauthnrequestassertionconsumerserviceurl(void* lpObj, const char* lpszAuthnRequestAssertionConsumerServiceURL);

QString GetAuthnRequestAssertionConsumerServiceURL();
int SetAuthnRequestAssertionConsumerServiceURL(QString qsAuthnRequestAssertionConsumerServiceURL);

Default Value

""

Remarks

Specifies the assertion consumer service URL.

Use this property to access or set the URL of the location to which the response has to be returned.

This property is not available at design time.

Data Type

String

AuthnRequestAttributeConsumingServiceIndex Property (SAMLWriter Class)

Specifies the attribute consuming service index.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestAttributeConsumingServiceIndex();
int SetAuthnRequestAttributeConsumingServiceIndex(int iAuthnRequestAttributeConsumingServiceIndex);

Unicode (Windows)
INT GetAuthnRequestAttributeConsumingServiceIndex();
INT SetAuthnRequestAttributeConsumingServiceIndex(INT iAuthnRequestAttributeConsumingServiceIndex);

int secureblackbox_samlwriter_getauthnrequestattributeconsumingserviceindex(void* lpObj);
int secureblackbox_samlwriter_setauthnrequestattributeconsumingserviceindex(void* lpObj, int iAuthnRequestAttributeConsumingServiceIndex);

int GetAuthnRequestAttributeConsumingServiceIndex();
int SetAuthnRequestAttributeConsumingServiceIndex(int iAuthnRequestAttributeConsumingServiceIndex);

Default Value

0

Remarks

Specifies the attribute consuming service index.

Use this property to read or set the attribute consuming service index.

This property is not available at design time.

Data Type

Integer

AuthnRequestConditionsNotBefore Property (SAMLWriter Class)

Specifies the NotBefore condition of the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnRequestConditionsNotBefore();
int SetAuthnRequestConditionsNotBefore(const char* lpszAuthnRequestConditionsNotBefore);

Unicode (Windows)
LPWSTR GetAuthnRequestConditionsNotBefore();
INT SetAuthnRequestConditionsNotBefore(LPCWSTR lpszAuthnRequestConditionsNotBefore);

char* secureblackbox_samlwriter_getauthnrequestconditionsnotbefore(void* lpObj);
int secureblackbox_samlwriter_setauthnrequestconditionsnotbefore(void* lpObj, const char* lpszAuthnRequestConditionsNotBefore);

QString GetAuthnRequestConditionsNotBefore();
int SetAuthnRequestConditionsNotBefore(QString qsAuthnRequestConditionsNotBefore);

Default Value

""

Remarks

Specifies the NotBefore condition of the request.

Use this property to access or set the NotBefore condition of the request.

This property is not available at design time.

Data Type

String

AuthnRequestConditionsNotOnOrAfter Property (SAMLWriter Class)

Provides access to the NotOnOrAfter condition of the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnRequestConditionsNotOnOrAfter();
int SetAuthnRequestConditionsNotOnOrAfter(const char* lpszAuthnRequestConditionsNotOnOrAfter);

Unicode (Windows)
LPWSTR GetAuthnRequestConditionsNotOnOrAfter();
INT SetAuthnRequestConditionsNotOnOrAfter(LPCWSTR lpszAuthnRequestConditionsNotOnOrAfter);

char* secureblackbox_samlwriter_getauthnrequestconditionsnotonorafter(void* lpObj);
int secureblackbox_samlwriter_setauthnrequestconditionsnotonorafter(void* lpObj, const char* lpszAuthnRequestConditionsNotOnOrAfter);

QString GetAuthnRequestConditionsNotOnOrAfter();
int SetAuthnRequestConditionsNotOnOrAfter(QString qsAuthnRequestConditionsNotOnOrAfter);

Default Value

""

Remarks

Provides access to the NotOnOrAfter condition of the request.

Use this property to access or set the NotOnOrAfter condition of the request.

This property is not available at design time.

Data Type

String

AuthnRequestContextClassRefs Property (SAMLWriter Class)

Provides access to the authentication context class references.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthnRequestContextClassRefs();
int SetAuthnRequestContextClassRefs(const char* lpszAuthnRequestContextClassRefs);

Unicode (Windows)
LPWSTR GetAuthnRequestContextClassRefs();
INT SetAuthnRequestContextClassRefs(LPCWSTR lpszAuthnRequestContextClassRefs);

char* secureblackbox_samlwriter_getauthnrequestcontextclassrefs(void* lpObj);
int secureblackbox_samlwriter_setauthnrequestcontextclassrefs(void* lpObj, const char* lpszAuthnRequestContextClassRefs);

QString GetAuthnRequestContextClassRefs();
int SetAuthnRequestContextClassRefs(QString qsAuthnRequestContextClassRefs);

Default Value

""

Remarks

Provides access to the authentication context class references.

Use this property to access or set the class references of the authentication context. This property may contain a list of CRLF-separated strings.

This property is not available at design time.

Data Type

String

AuthnRequestContextComparison Property (SAMLWriter Class)

Specifies the AuthnContext comparison method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestContextComparison();
int SetAuthnRequestContextComparison(int iAuthnRequestContextComparison);

Unicode (Windows)
INT GetAuthnRequestContextComparison();
INT SetAuthnRequestContextComparison(INT iAuthnRequestContextComparison);

CACCT_NONE(0), 
CACCT_EXACT(1), 
CACCT_MINIMUM(2), 
CACCT_MAXIMUM(3), 
CACCT_BETTER(4)

int secureblackbox_samlwriter_getauthnrequestcontextcomparison(void* lpObj);
int secureblackbox_samlwriter_setauthnrequestcontextcomparison(void* lpObj, int iAuthnRequestContextComparison);

int GetAuthnRequestContextComparison();
int SetAuthnRequestContextComparison(int iAuthnRequestContextComparison);

Default Value

0

Remarks

Specifies the AuthnContext comparison method.

Use this property to access or set the authentication contexts comparison method (none, exact, minimum, maximum, or better).

This property is not available at design time.

Data Type

Integer

AuthnRequestContextRefType Property (SAMLWriter Class)

Specifies the context reference type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestContextRefType();
int SetAuthnRequestContextRefType(int iAuthnRequestContextRefType);

Unicode (Windows)
INT GetAuthnRequestContextRefType();
INT SetAuthnRequestContextRefType(INT iAuthnRequestContextRefType);

CACRT_UNKNOWN(0), 
CACRT_CLASS(1), 
CACRT_DECL(2)

int secureblackbox_samlwriter_getauthnrequestcontextreftype(void* lpObj);
int secureblackbox_samlwriter_setauthnrequestcontextreftype(void* lpObj, int iAuthnRequestContextRefType);

int GetAuthnRequestContextRefType();
int SetAuthnRequestContextRefType(int iAuthnRequestContextRefType);

Default Value

0

Remarks

Specifies the context reference type.

Use this property to get or set the context reference type (Class or Declaration).

This property is not available at design time.

Data Type

Integer

AuthnRequestForceAuthn Property (SAMLWriter Class)

Corresponds to the ForceAuthn parameter of the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestForceAuthn();
int SetAuthnRequestForceAuthn(int bAuthnRequestForceAuthn);

Unicode (Windows)
BOOL GetAuthnRequestForceAuthn();
INT SetAuthnRequestForceAuthn(BOOL bAuthnRequestForceAuthn);

int secureblackbox_samlwriter_getauthnrequestforceauthn(void* lpObj);
int secureblackbox_samlwriter_setauthnrequestforceauthn(void* lpObj, int bAuthnRequestForceAuthn);

bool GetAuthnRequestForceAuthn();
int SetAuthnRequestForceAuthn(bool bAuthnRequestForceAuthn);

Default Value

FALSE

Remarks

Corresponds to the ForceAuthn parameter of the request.

Use this property to check or set the ForceAuthn parameter of the request, which enforces the identity provider to re-authenticate the presenter.

This property is not available at design time.

Data Type

Boolean

AuthnRequestIsPassive Property (SAMLWriter Class)

Maps to the IsPassive parameter of the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestIsPassive();
int SetAuthnRequestIsPassive(int bAuthnRequestIsPassive);

Unicode (Windows)
BOOL GetAuthnRequestIsPassive();
INT SetAuthnRequestIsPassive(BOOL bAuthnRequestIsPassive);

int secureblackbox_samlwriter_getauthnrequestispassive(void* lpObj);
int secureblackbox_samlwriter_setauthnrequestispassive(void* lpObj, int bAuthnRequestIsPassive);

bool GetAuthnRequestIsPassive();
int SetAuthnRequestIsPassive(bool bAuthnRequestIsPassive);

Default Value

FALSE

Remarks

Maps to the IsPassive parameter of the request.

Use this property to access or set the IsPassive parameter of the authentication request. IsPassive sets out the control the identity provider and user agent have over the authenticating users UI.

This property is not available at design time.

Data Type

Boolean

AuthnRequestNameIDPolicyAllowCreate Property (SAMLWriter Class)

Matches the AllowCreate attribute of NameIDPolicy element of the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthnRequestNameIDPolicyAllowCreate();
int SetAuthnRequestNameIDPolicyAllowCreate(int bAuthnRequestNameIDPolicyAllowCreate);

Unicode (Windows)
BOOL GetAuthnRequestNameIDPolicyAllowCreate();
INT SetAuthnRequestNameIDPolicyAllowCreate(BOOL bAuthnRequestNameIDPolicyAllowCreate);

int secureblackbox_samlwriter_getauthnrequestnameidpolicyallowcreate(void* lpObj);
int secureblackbox_samlwriter_setauthnrequestnameidpolicyallowcreate(void* lpObj, int bAuthnRequestNameIDPolicyAllowCreate);

bool GetAuthnRequestNameIDPolicyAllowCreate();
int SetAuthnRequestNameIDPolicyAllowCreate(bool bAuthnRequestNameIDPolicyAllowCreate);

Default Value

FALSE

Remarks

Matches the AllowCreate attribute of NameIDPolicy element of the request.

Use this property to access or set the AllowCreate attribute of NameIDPolicy, which allows or disallows the identity provider to create a new identifier when processing the authentication request.

This property is not available at design time.

Data Type

Boolean

AuthnRequestNameIDPolicyFormat Property (SAMLWriter Class)

Matches to the Format attribute of the NameIDPolicy element of the request.

Syntax

• C++
• C
• Qt