Skip to main content


class %SOAP.Security.UsernameToken extends %SOAP.Security.Element

UsernameToken for SOAP Security header.

Property Inventory

Method Inventory


parameter NAMESPACE =;
Inherited description: NAMESPACE specifies the XML namespace to be used when projecting the class to XML. If NAMESPACE = "", the default namespace is used for the XML schema is used as the namespace for his class.
parameter XMLFORMAT = literal;
Inherited description: The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport methods for XML enabled classes to include code for only literal or only encoded format. This allows the generated routines to be significantly smaller since usually both formats are not needed.

If XMLFORMAT="Literal", then only support for literal format import and export is generated.

If XMLFORMAT="Encoded", then only support for SOAP encoded format import and export is generated.

The default is to generate support for both literal and encoded format.


property Created as %xsd.dateTime (REFELEMENTQUALIFIED = 1, REFNAMESPACE = "", XMLREF = 1);
Property methods: CreatedDisplayToLogical(), CreatedGet(), CreatedIsValid(), CreatedLogicalToDisplay(), CreatedLogicalToXSD(), CreatedNormalize(), CreatedOdbcToLogical(), CreatedSet(), CreatedXSDToLogical()
property Nonce as %Binary);
Property methods: NonceGet(), NonceIsValid(), NonceLogicalToXSD(), NonceSet(), NonceXSDToLogical()
property Password as %SOAP.Security.Password;
Property methods: PasswordGet(), PasswordGetObject(), PasswordGetObjectId(), PasswordGetSwizzled(), PasswordIsEmpty(), PasswordIsValid(), PasswordNewObject(), PasswordSet(), PasswordSetObject(), PasswordSetObjectId(), PasswordUnSwizzle()
property Username as %String (CONTENT = "escape");
Property methods: UsernameDisplayToLogical(), UsernameGet(), UsernameIsValid(), UsernameLogicalToDisplay(), UsernameLogicalToOdbc(), UsernameNormalize(), UsernameSet()


classmethod Create(username As %String, password As %String, type As %String) as %SOAP.Security.UsernameToken
Create a UsernameToken element containing the specified username. The password is specified by the type argument as follows:
  • $$$SOAPWSPasswordText is a plain text password. This is the default.
  • $$$SOAPWSPasswordDigest is a password digest based on the specified password. The password digest, Nonce and Created timestamp are derived as specified by WS-Security 1.1.
    $$$SOAPWSPasswordDigest is available only for SOAP clients interacting with third-party servers that support it. PasswordDigest authentication requires the server to store the plain-text password, which is not acceptable in a modern security environment. The PasswordDigest algorithm is a legacy feature. To protect the password in a <UsernameToken>, you should use SSL/TLS, encrypt the <UsernameToken>, or both.
  • $$$SOAPWSPasswordNone means no password element is included.

Inherited Members

Inherited Methods


FeedbackOpens in a new tab