Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%SOAP] >  [Security] >  [UsernameToken]
Private  Storage   

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

UsernameToken for SOAP Security header.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 4 2


Summary

Properties
Created Nonce Password Username

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
Create XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType

Subclasses
%SOAP.Security.wsse200207.UsernameToken %SOAP.Security.wsse200306.UsernameToken

Parameters

• parameter NAMESPACE = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd";
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";
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.


Properties

• property Created as %xsd.dateTime(REFELEMENTQUALIFIED=1,REFNAMESPACE="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd",XMLREF=1);
• property Nonce as %Binary(MAXLEN="");
• property Password as %SOAP.Security.Password;
• property Username as %String(CONTENT="escape",MAXLEN="");

Methods

• 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.


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.