Skip to main content

%SYS.OpenAM.IdentityServices

Class %SYS.OpenAM.IdentityServices Extends (%Persistent, %XML.Adaptor) [ System = 4 ]

This class represents an interface to an instance of OpenAM Enterprise Identity Web Services hosted by an application server.

Parameters​

VERSION​

Parameter VERSION [ Internal ] = 1;

SOURCECONTROL​

Parameter SOURCECONTROL [ Internal ] = {"Revision path: $Id: //iris/2024.3.0/databases/sys/cls/SYS/OpenAM/IdentityServices.xml#1 $"_$c(13,10)_"Last Change:   $DateTime: 2024/10/02 10:58:11 $"_$c(13,10)_"Changelist #:  $Change: 7247250 $"};

Properties​

Name​

Property Name As %String [ Required ];

Name of this instance.

Server​

Property Server As %String [ InitialExpression = "localhost", Required ];

DNS name of the application server hosting OpenAM Enterprise Identity Web Services.

Port​

Property Port As %Integer [ InitialExpression = 8080, Required ];

TCP port that the application server hosting OpenAM Enterprise Identity Web Services is listening on.

Path​

Property Path As %String [ InitialExpression = "/opensso/identityservices", Required ];

Path to OpenAM Identity Services on the application server hosting OpenAM Enterprise Identity Web Services.

SSLConfiguration​

Property SSLConfiguration As %String;

SSL client configuration to use when connecting to the application server hosting OpenAM Enterprise Identity Web Services. (optional)

Token​

Property Token As %Net.OpenAM.tns.token(XMLPROJECTION = "NONE") [ Internal, Transient ];

Security token obtained on successful authentication.

Version​

Property Version As %Decimal(SCALE = 1) [ Internal ];

Version number of the record.
Used for Export/Import.

Methods​

Authenticate​

Method Authenticate(Username As %String, Password As %String) As %Boolean

Authenticate the Username and Password, obtaining an internal transient security token if successful.

Save​

Method Save() As %Status

Allow a process with %Admin_Secure:U, but not %DB_IRISSYS:RW, to save an OpenAMIdentityServices object. (A process with %DB_IRISSYS:RW can use %Save.)

%OnBeforeSave​

Method %OnBeforeSave(insert As %Boolean) As %Status [ Internal, Private ]

Require %AdminSecure:U

%OnAfterSave​

Method %OnAfterSave(insert As %Boolean) As %Status [ Internal, Private ]

This callback method is invoked by the %Save method to provide notification that the object is being saved. It is called after the object's data has been successfully written to disk.

insert will be set to 1 if this object is being saved for the first time.

If this method returns an error then the call to %Save will fail.

%OnDelete​

ClassMethod %OnDelete(oid As %ObjectIdentity) As %Status [ Internal, Private, ServerOnly = 1 ]

Caller of %Delete must have %Admin_Secure:U.

StartEMS​

ClassMethod StartEMS() As %Status [ Internal ]

DeleteId​

ClassMethod DeleteId(Name As %String) As %Status

Allow a process with %Admin_Secure:U, but not %DB_IRISSYS:RW, to delete an OpenAMIdentityServices object. (A process with %DB_IRISSYS:RW can use %Save.)

Test​

Method Test() As %Boolean

Test whether this instance is correctly configured to use OpenAM Identity Web Services.

Exists​

ClassMethod Exists(Name As %String, ByRef OpenAMIdentityService As %ObjectHandle, ByRef Status As %Status) As %Boolean

OpenAMIdentityService exists.
This method checks for the existence of a OpenAMIdentityService in the security database.
Parameters:
Name - Name of the OpenAMIdentityService to check existence of
Return values:
If Value of the method = 0 (OpenAMIdentityService does not exist, or some error occured)
OpenAMIdentityService = Null
Status = OpenAMIdentityService "x" does not exist, or other error message

If Value of the method = 1 (OpenAMIdentityService exists)
OpenAMIdentityService = Object handle to OpenAMIdentityService
Status = $$$OK

Export​

ClassMethod Export(FileName As %String = "OpenAMIdentityServicesExport.xml", ByRef NumExported As %Integer, OpenAMIdentityServices As %String = "*") As %Status

This method exports OpenAMIdentityService records to a file in xml format.
Parameters:
Filename - Output file name
NumExported (byref) - Returns number of records exported.
OpenAMIdentityServices - Comma separated list of OpenAMIdentityServices to export, "*" = All

GetProperties​

ClassMethod GetProperties(OpenAMIdentityService As %ObjectHandle, ByRef Properties As %String) As %Status

Get a OpenAMIdentityService's properties.
Gets a OpenAMIdentityServices's properties from the security database.
Parameters:
OpenAMIdentityService - Object handle to a OpenAMIdentityServices record
Return values:
Properties - See the Get method for more information on properties returned

Import​

ClassMethod Import(FileName As %String = "OpenAMIdentityServicesExport.xml", ByRef NumImported As %Integer, Flags As %Integer = 0) As %Status

Import OpenAMIdentityService records from an xml file.
Parameters:
FileName - Filename to import OpenAMIdentityService records from
NumImported (byref) - Returns number of records imported
Flags - Control import
Bit 0 - Do not import records, just return count
Note: On failure, no records will be imported

Modify​

ClassMethod Modify(Name As %String, ByRef Properties As %String) As %Status

Modify a OpenAMIdentityService.
Modify an existing OpenAMIdentityService's properties in the security database.
Parameters:
Name - Name of the OpenAMIdentityService to modify
Properties - Array of properties to modify.
See the Get() method for a description of the Properties parameter.
If a specific property is not passed in the properties array, the value is not modified.

Upload​

ClassMethod Upload(GUID As %String, ByRef Data As %List) As %Status [ Internal ]

Upload all OpenAMIdentityServices from Enterprise Management System to requesting client.