SCIMDesktop Class

Properties   Methods   Events   Config Settings   Errors  

The SCIMDesktop class provides an easy way to add automatic user and group provisioning to your desktop application.

Class Name

CloudSSO_SCIMDesktop

Procedural Interface

 cloudsso_scimdesktop_open();
 cloudsso_scimdesktop_close($res);
 cloudsso_scimdesktop_register_callback($res, $id, $function);
 cloudsso_scimdesktop_get_last_error($res);
 cloudsso_scimdesktop_get_last_error_code($res);
 cloudsso_scimdesktop_set($res, $id, $index, $value);
 cloudsso_scimdesktop_get($res, $id, $index);
 cloudsso_scimdesktop_do_addgroup($res, $groupid, $displayname, $externalid);
 cloudsso_scimdesktop_do_addgroupmember($res, $groupid, $memberid, $memberdisplay);
 cloudsso_scimdesktop_do_adduser($res, $userid, $username, $displayname, $externalid, $active);
 cloudsso_scimdesktop_do_adduseremail($res, $userid, $address, $emailtype, $primary);
 cloudsso_scimdesktop_do_adduserextension($res, $userid, $department, $employeenumber, $costcenter, $organization, $division, $managerid, $managerref, $managerdisplayname);
 cloudsso_scimdesktop_do_adduserphone($res, $userid, $number, $phonetype, $primary);
 cloudsso_scimdesktop_do_config($res, $configurationstring);
 cloudsso_scimdesktop_do_disconnect($res, $connectionid);
 cloudsso_scimdesktop_do_doevents($res);
 cloudsso_scimdesktop_do_reset($res);
 cloudsso_scimdesktop_do_shutdown($res);
 cloudsso_scimdesktop_do_startlistening($res);
 cloudsso_scimdesktop_do_stoplistening($res);

Remarks

The System for Cross-domain Identity Management (SCIM) protocol gives an Identity Provider (e.g., Okta or Microsoft Entra ID) a standardized way to automatically create, update, and deactivate accounts in your application. Instead of an administrator manually managing an account in every connected application, SCIM lets the Identity Provider push those changes out over a simple REST/JSON API whenever a user is hired, changes departments, or leaves the company.

The Identity Provider acts as the client, and your application is the SCIM service provider. This class implements the service provider role. It listens for incoming HTTP connections, parses each SCIM request, fires an event so your application can create, look up, update, or delete the corresponding record in its own data store, and then builds and sends the SCIM JSON response.

Unlike the SCIMWeb class, which is embedded within an existing web application or framework, this class hosts its own embedded HTTP server, so no external web server is required. This makes it well suited to a desktop application or background service that needs to expose a SCIM endpoint on its own.

Setup

The LocalHost and LocalPort properties are used to control the address and port the embedded server listens on. The StartListening method must be called to begin actively listening for incoming connections.

The MaxConnections and IdleTimeout properties may be used to control how many simultaneous connections are accepted and how long an idle connection is kept open, respectively. To expose the endpoint over HTTPS, the SSLEnabled property may be enabled alongside the specification of a certificate via the SSLCert property before calling StartListening.

scim.LocalHost = "127.0.0.1"; scim.LocalPort = 8443; scim.SSLCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); scim.SSLEnabled = true; scim.StartListening();

The class may also be configured with information about which SCIM operations to support and how requests should be routed. The BaseURL property is the path prefix used to recognize SCIM resource paths, and the SupportedOperations property is a bitmask that controls which combinations of HTTP method and resource type are accepted. The MaxResults property dictates how many resources can be returned from a single list request.

scim.BaseURL = "/scim/v2"; scim.SupportedOperations = SupportedOperations.sopAll; scim.MaxResults = 200;

Authentication

Every incoming request fires the AuthRequest event before any resource-specific event is raised, giving the application the chance to accept or reject the request. The AuthMethod parameter identifies the scheme supplied by the client, detailed below.

The AllowedClients and BlockedClients configuration settings may be used if connections should be restricted at the network level as well.

A static bearer token may be supplied to the class as shown.

scim.AuthToken = "the-token-issued-to-your-identity-provider";

Alternatively, custom validation may be performed as shown.

scim.OnAuthRequest += (sender, e) => { e.Accept = e.AuthMethod == "Bearer" && tokenStore.IsValid(e.Token); };

User Management

The class fires an event for each standard SCIM user operation, giving the application full control over how users are stored.

Creating a User

A POST /Users request causes the CreateUser event to be fired with the submitted attributes, including any addresses and phone numbers through the UserEmails and UserPhones properties and enterprise attributes (department, employee number, manager, and so on) through the UserExtension property. The handler must assign and return a unique UserId and set the StatusCode parameter to 201.

Retrieving and Listing Users

A GET /Users/{id} request causes the GetUser event to be fired. The handler populates the user's current attributes and the AddUserEmail, AddUserPhone, and AddUserExtension methods may be called to include any related data.

A GET /Users request causes the ListUsers event to be fired instead, with pagination reflected in the StartIndex and Count parameters and, for simple single-term filters such as userName eq "jsmith", the parsed FilterAttribute, FilterOperator, and FilterValue parameters. The AddUser method should be called once per matching user, and the TotalResults parameter should be set to the total across all pages.

scim.OnListUsers += (sender, e) => { var page = db.QueryUsers(e.FilterAttribute, e.FilterOperator, e.FilterValue, e.StartIndex - 1, e.Count); foreach (var user in page.Results) { scim.AddUser(user.Id, user.UserName, user.DisplayName, user.ExternalId, user.Active); } e.TotalResults = page.TotalCount; e.StatusCode = 200; };

Updating and Deleting Users

Both PUT /Users/{id} and PATCH /Users/{id} requests cause the UpdateUser event to be fired. For a PATCH request, the class first fires the GetUser event to load the current record, applies the patch operations from the request (including path-filtered operations such as emails[type eq "work"]) internally, and then fires the UpdateUser event with the fully merged result, so the handler always sees a complete, final representation of the user regardless of which method was used. The read-only RequestType property should be used if the handler needs to distinguish which method triggered the current event.

A DELETE /Users/{id} request causes the DeleteUser event to be fired. Deactivating a user without deleting their record is done the standard SCIM way, by setting the Active parameter to false through an update rather than issuing a delete.

Group Management

Groups follow the same pattern as users, and the CreateGroup, GetGroup, ListGroups, UpdateGroup, and DeleteGroup events all mirror their user counterparts. Group members are provided through the GroupMembers properties on create and update, and are added to an outgoing response with the AddGroupMember method. The AddGroup method is used to add each group to a ListGroups event response.

Discovery Endpoints

The class automatically answers the standard SCIM discovery endpoints so an Identity Provider can inspect your service provider's capabilities before provisioning begins.

A GET /ServiceProviderConfig request, which causes the GetServiceProviderConfig event to be fired, advertises the supported authentication scheme and which operations are enabled, based on the SupportedOperations property. GET /ResourceTypes requests, which cause the GetResourceTypes event to be fired, and GET /Schemas requests, which cause the GetSchemas event to be fired, describe the User and Group resource and schema definitions, including the enterprise user extension. All three events are informational, so the response body has already been generated by the time each one fires.

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.

AuthToken Property (CloudSSO_SCIMDesktop Class)

The Bearer token used to authenticate incoming SCIM requests.

Object Oriented Interface

public function getAuthToken();
public function setAuthToken($value);

Procedural Interface

cloudsso_scimdesktop_get($res, 1);
cloudsso_scimdesktop_set($res, 1, $value);

Default Value

''

Remarks

When this property is set, the class compares the incoming authorization bearer token against its value and initializes the Accept parameter of the AuthRequest event accordingly before the event fires. If the token is missing or does not match, the Accept parameter will be set to false. Likewise, if a match is found, the Accept parameter will be set to true. This value may be overridden in the handler when the AuthRequest event fires (e.g., the handler can reject a matching token to enforce expiry or check a revocation list).

This property only takes effect for Bearer authentication and has no influence on other authentication schemes.

When this property is empty, no automatic comparison is performed and Accept defaults to false. Without an AuthRequest handler that explicitly accepts the request, all incoming requests receive a 401 Unauthorized response.

Data Type

String

BaseURL Property (CloudSSO_SCIMDesktop Class)

The base URL path for SCIM endpoints.

Object Oriented Interface

public function getBaseURL();
public function setBaseURL($value);

Procedural Interface

cloudsso_scimdesktop_get($res, 2);
cloudsso_scimdesktop_set($res, 2, $value);

Default Value

'/scim/v2'

Remarks

This property defines the base path prefix the class uses when routing incoming requests to SCIM endpoints. All SCIM resource paths are resolved relative to this value (e.g., with the default value of /scim/v2, a request for /scim/v2/Users is recognized as a User list request).

This value must begin with a forward slash. Trailing slashes are removed automatically, so /scim/v2/ and /scim/v2 are equivalent.

Data Type

String

ConnectionBacklog Property (CloudSSO_SCIMDesktop Class)

This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem.

Object Oriented Interface

public function getConnectionBacklog();
public function setConnectionBacklog($value);

Procedural Interface

cloudsso_scimdesktop_get($res, 3);
cloudsso_scimdesktop_set($res, 3, $value);

Default Value

5

Remarks

This property contains the maximum number of pending connections maintained by the TCP/IP subsystem. This value reflects the SOMAXCONN option for the main listening socket. The default value for most systems is 5. You may set this property to a larger value if the server is expected to receive a large number of connections, and queuing them is desirable.

This property is not available at design time.

Data Type

Integer

GroupMemberCount Property (CloudSSO_SCIMDesktop Class)

The number of records in the GroupMember arrays.

Object Oriented Interface

public function getGroupMemberCount();

Procedural Interface

cloudsso_scimdesktop_get($res, 4);

Default Value

0

Remarks

This property controls the size of the following arrays:

• GroupMemberMemberDisplay
• GroupMemberMemberId

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

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

Data Type

Integer

GroupMemberMemberDisplay Property (CloudSSO_SCIMDesktop Class)

The display name of the group member.

Object Oriented Interface

public function getGroupMemberMemberDisplay($groupmemberindex);

Procedural Interface

cloudsso_scimdesktop_get($res, 5, $groupmemberindex);

Default Value

''

Remarks

The display name of the group member.

This property contains the display name of the member user as provided by the Identity Provider. It may be empty if the Identity Provider did not supply a display name.

The $groupmemberindex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupMemberCount property.

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

Data Type

String

GroupMemberMemberId Property (CloudSSO_SCIMDesktop Class)

The SCIM resource ID of the group member.

Object Oriented Interface

public function getGroupMemberMemberId($groupmemberindex);

Procedural Interface

cloudsso_scimdesktop_get($res, 6, $groupmemberindex);

Default Value

''

Remarks

The SCIM resource ID of the group member.

This property contains the unique identifier of the member user as assigned by the service provider.

The $groupmemberindex parameter specifies the index of the item in the array. The size of the array is controlled by the GroupMemberCount property.

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

Data Type

String

IdleTimeout Property (CloudSSO_SCIMDesktop Class)

The number of seconds before an idle connection is closed.

Object Oriented Interface

public function getIdleTimeout();
public function setIdleTimeout($value);

Procedural Interface

cloudsso_scimdesktop_get($res, 7);
cloudsso_scimdesktop_set($res, 7, $value);

Default Value

10

Remarks

This property is used to specify how long, in seconds, the embedded server allows a connection to remain idle (i.e., no data sent or received) before closing it.

The default timeout is 10 seconds, and a value of 0 may be provided to disable the timeout.

Data Type

Integer

Listening Property (CloudSSO_SCIMDesktop Class)

This property indicates whether the class is listening for incoming connections on LocalPort.

Object Oriented Interface

public function getListening();

Procedural Interface

cloudsso_scimdesktop_get($res, 8);

Default Value

false

Remarks

This property indicates whether the class is listening for connections on the port specified by the LocalPort property. Use the StartListening and StopListening methods to control whether the class is listening.

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

Data Type

Boolean

LocalHost Property (CloudSSO_SCIMDesktop Class)

The address on which the embedded HTTP server listens.

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

cloudsso_scimdesktop_get($res, 9);
cloudsso_scimdesktop_set($res, 9, $value);

Default Value

''

Remarks

This property is used to specify the local interface address on which the embedded HTTP server binds. The default is "" (empty string), which causes the server to listen on all available interfaces.

This property should be set to a specific IP address to restrict the server to a single network interface (e.g., 127.0.0.1 to accept only local connections).

Data Type

String

LocalPort Property (CloudSSO_SCIMDesktop Class)

The port on which the embedded HTTP server listens.

Object Oriented Interface

public function getLocalPort();
public function setLocalPort($value);

Procedural Interface

cloudsso_scimdesktop_get($res, 10);
cloudsso_scimdesktop_set($res, 10, $value);

Default Value

80

Remarks

This property is used to specify the TCP port on which the server accepts SCIM requests. The default is 80, and it must be set before calling the StartListening method.

This property should be set to 0 to cause the system to choose a random available port. After StartListening is called, this property may be queried to read the actual port assigned.

When the SSLEnabled property is enabled, the server automatically listens for TLS connections. If this property is still at its default of 80 when SSLEnabled is toggled, the port switches to 443 automatically. If a non-default port has already been set, it is not changed.

This property is not available at design time.

Data Type

Integer

MaxConnections Property (CloudSSO_SCIMDesktop Class)

The maximum number of simultaneous connections the server will accept.

Object Oriented Interface

public function getMaxConnections();
public function setMaxConnections($value);

Procedural Interface

cloudsso_scimdesktop_get($res, 11);
cloudsso_scimdesktop_set($res, 11, $value);

Default Value

100000

Remarks

This property controls how many concurrent connections the embedded server will maintain. An incoming connection attempt beyond this limit is accepted and immediately closed.

The default, and maximum supported, value is 100,000. Unlike LocalHost and LocalPort, this property may be changed at any time, even while the server is listening. The new limit applies to subsequent connection attempts.

Data Type

Integer

MaxResults Property (CloudSSO_SCIMDesktop Class)

The maximum number of resources requested from the application in a single list request.

Object Oriented Interface

public function getMaxResults();
public function setMaxResults($value);

Procedural Interface

cloudsso_scimdesktop_get($res, 12);
cloudsso_scimdesktop_set($res, 12, $value);

Default Value

200

Remarks

This property limits the Count parameter of the ListUsers and ListGroups events. When the Identity Provider omits the count query parameter or requests more results than this value, Count is set to this value. The class does not remove resources from the response, so the event handler should add no more than Count resources.

This value is also reported in the ServiceProviderConfig discovery endpoint as the maximum allowed value for pagination.

Data Type

Integer

RequestType Property (CloudSSO_SCIMDesktop Class)

The HTTP method of the request currently being processed.

Object Oriented Interface

public function getRequestType();

Procedural Interface

cloudsso_scimdesktop_get($res, 13);

Default Value

''

Remarks

This read-only property is used to determine the HTTP method (GET, POST, PUT, PATCH, or DELETE) of the request being processed. It is eligible to be queried during any event fired by the class.

When the class processes a PATCH request, it fires the GetUser or GetGroup event to retrieve the current resource first. When the ETagEnabled configuration setting is true and the client includes an If-Match header on a PUT or DELETE request, the GetUser or GetGroup event also fires to validate the ETag before the update or delete event.

This property is read-only.

Data Type

String

SSLAuthenticateClients Property (CloudSSO_SCIMDesktop Class)

If set to True, the server asks the client(s) for a certificate.

Object Oriented Interface

public function getSSLAuthenticateClients();
public function setSSLAuthenticateClients($value);

Procedural Interface

cloudsso_scimdesktop_get($res, 14);
cloudsso_scimdesktop_set($res, 14, $value);

Default Value

false

Remarks

This property is used in conjunction with the SSLClientAuthentication event. Please refer to the documentation of the SSLClientAuthentication event for details.

Data Type

Boolean

SSLCertEffectiveDate Property (CloudSSO_SCIMDesktop Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

cloudsso_scimdesktop_get($res, 15);

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (CloudSSO_SCIMDesktop Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

cloudsso_scimdesktop_get($res, 16);

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (CloudSSO_SCIMDesktop Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

cloudsso_scimdesktop_get($res, 17);

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (CloudSSO_SCIMDesktop Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

cloudsso_scimdesktop_get($res, 18);

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (CloudSSO_SCIMDesktop Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

cloudsso_scimdesktop_get($res, 19);

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (CloudSSO_SCIMDesktop Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

cloudsso_scimdesktop_get($res, 20);

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (CloudSSO_SCIMDesktop Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

cloudsso_scimdesktop_get($res, 21);

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (CloudSSO_SCIMDesktop Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

cloudsso_scimdesktop_get($res, 22);

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (CloudSSO_SCIMDesktop Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

cloudsso_scimdesktop_get($res, 23);

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (CloudSSO_SCIMDesktop Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

cloudsso_scimdesktop_get($res, 24);

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (CloudSSO_SCIMDesktop Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

cloudsso_scimdesktop_get($res, 25);

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (CloudSSO_SCIMDesktop Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

cloudsso_scimdesktop_get($res, 26);

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (CloudSSO_SCIMDesktop Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

cloudsso_scimdesktop_get($res, 27);

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (CloudSSO_SCIMDesktop Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

cloudsso_scimdesktop_get($res, 28);

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (CloudSSO_SCIMDesktop Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

cloudsso_scimdesktop_get($res, 29);

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (CloudSSO_SCIMDesktop Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

cloudsso_scimdesktop_get($res, 30);
cloudsso_scimdesktop_set($res, 30, $value);

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (CloudSSO_SCIMDesktop Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

cloudsso_scimdesktop_get($res, 31);
cloudsso_scimdesktop_set($res, 31, $value);

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (CloudSSO_SCIMDesktop Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

cloudsso_scimdesktop_get($res, 32);
cloudsso_scimdesktop_set($res, 32, $value);

Possible Values

SCIMDESKTOP_SSLCERTSTORETYPE_USER(0), 
SCIMDESKTOP_SSLCERTSTORETYPE_MACHINE(1), 
SCIMDESKTOP_SSLCERTSTORETYPE_PFXFILE(2), 
SCIMDESKTOP_SSLCERTSTORETYPE_PFXBLOB(3), 
SCIMDESKTOP_SSLCERTSTORETYPE_JKSFILE(4), 
SCIMDESKTOP_SSLCERTSTORETYPE_JKSBLOB(5), 
SCIMDESKTOP_SSLCERTSTORETYPE_PEMKEY_FILE(6), 
SCIMDESKTOP_SSLCERTSTORETYPE_PEMKEY_BLOB(7), 
SCIMDESKTOP_SSLCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
SCIMDESKTOP_SSLCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
SCIMDESKTOP_SSLCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
SCIMDESKTOP_SSLCERTSTORETYPE_P7BFILE(11), 
SCIMDESKTOP_SSLCERTSTORETYPE_P7BBLOB(12), 
SCIMDESKTOP_SSLCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
SCIMDESKTOP_SSLCERTSTORETYPE_PPKFILE(14), 
SCIMDESKTOP_SSLCERTSTORETYPE_PPKBLOB(15), 
SCIMDESKTOP_SSLCERTSTORETYPE_XMLFILE(16), 
SCIMDESKTOP_SSLCERTSTORETYPE_XMLBLOB(17), 
SCIMDESKTOP_SSLCERTSTORETYPE_JWKFILE(18), 
SCIMDESKTOP_SSLCERTSTORETYPE_JWKBLOB(19), 
SCIMDESKTOP_SSLCERTSTORETYPE_SECURITY_KEY(20), 
SCIMDESKTOP_SSLCERTSTORETYPE_BCFKSFILE(21), 
SCIMDESKTOP_SSLCERTSTORETYPE_BCFKSBLOB(22), 
SCIMDESKTOP_SSLCERTSTORETYPE_PKCS11(23), 
SCIMDESKTOP_SSLCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubjectAltNames Property (CloudSSO_SCIMDesktop Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

cloudsso_scimdesktop_get($res, 33);

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (CloudSSO_SCIMDesktop Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

cloudsso_scimdesktop_get($res, 34);

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (CloudSSO_SCIMDesktop Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

cloudsso_scimdesktop_get($res, 35);

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (CloudSSO_SCIMDesktop Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

cloudsso_scimdesktop_get($res, 36);

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (CloudSSO_SCIMDesktop Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

cloudsso_scimdesktop_get($res, 37);

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (CloudSSO_SCIMDesktop Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

cloudsso_scimdesktop_get($res, 38);

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (CloudSSO_SCIMDesktop Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

cloudsso_scimdesktop_get($res, 39);

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (CloudSSO_SCIMDesktop Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

cloudsso_scimdesktop_get($res, 40);
cloudsso_scimdesktop_set($res, 40, $value);

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (CloudSSO_SCIMDesktop Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

cloudsso_scimdesktop_get($res, 41);
cloudsso_scimdesktop_set($res, 41, $value);

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLEnabled Property (CloudSSO_SCIMDesktop Class)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Object Oriented Interface

public function getSSLEnabled();
public function setSSLEnabled($value);

Procedural Interface

cloudsso_scimdesktop_get($res, 42);
cloudsso_scimdesktop_set($res, 42, $value);

Default Value

false

Remarks

This property specifies whether TLS/SSL is enabled in the class. When False (default), the class operates in plaintext mode. When True, TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (CloudSSO_SCIMDesktop Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

cloudsso_scimdesktop_get($res, 43);
cloudsso_scimdesktop_set($res, 43, $value);

Possible Values

SCIMDESKTOP_SSLPROVIDER_AUTOMATIC(0), 
SCIMDESKTOP_SSLPROVIDER_PLATFORM(1), 
SCIMDESKTOP_SSLPROVIDER_INTERNAL(2)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the class will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

Data Type

Integer

SupportedOperations Property (CloudSSO_SCIMDesktop Class)

A bitmask that controls which SCIM operations the class accepts.

Object Oriented Interface

public function getSupportedOperations();
public function setSupportedOperations($value);

Procedural Interface

cloudsso_scimdesktop_get($res, 44);
cloudsso_scimdesktop_set($res, 44, $value);

Default Value

65535

Remarks

This property determines which SCIM operations are enabled. Requests for disabled operations receive a 501 Not Implemented response. The following flags are defined (specified in hexadecimal notation) and may be combined:

Bits not listed above are reserved for future use and are currently ignored. sopAll is defined as 0xFFFF to include any operations added in future versions.

Note that PUT and PATCH requests share the same flag (sopUserUpdate / sopGroupUpdate). Enabling the flag accepts both methods, and disabling it rejects both. For PATCH requests, the class retrieves the current resource via GetUser or GetGroup, applies the patch operations, then fires UpdateUser or UpdateGroup with the merged result.

When the ETagEnabled configuration setting is enabled and a PUT or DELETE request includes an If-Match header, the class also fires GetUser or GetGroup to validate the ETag before the update or delete event fires.

The discovery endpoints (/ServiceProviderConfig, /ResourceTypes, /Schemas) are always available regardless of this property's value.

The capabilities advertised in the ServiceProviderConfig discovery endpoint are derived from this property automatically.

Data Type

Integer

UserEmailCount Property (CloudSSO_SCIMDesktop Class)

The number of records in the UserEmail arrays.

Object Oriented Interface

public function getUserEmailCount();

Procedural Interface

cloudsso_scimdesktop_get($res, 45);

Default Value

0

Remarks

This property controls the size of the following arrays:

• UserEmailAddress
• UserEmailPrimary
• UserEmailType

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

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

Data Type

Integer

UserEmailAddress Property (CloudSSO_SCIMDesktop Class)

The email address.

Object Oriented Interface

public function getUserEmailAddress($useremailindex);

Procedural Interface

cloudsso_scimdesktop_get($res, 46, $useremailindex);

Default Value

''

Remarks

The email address.

This property contains the email address value.

The $useremailindex parameter specifies the index of the item in the array. The size of the array is controlled by the UserEmailCount property.

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

Data Type

String

UserEmailType Property (CloudSSO_SCIMDesktop Class)

The type of email address.

Object Oriented Interface

public function getUserEmailType($useremailindex);

Procedural Interface

cloudsso_scimdesktop_get($res, 47, $useremailindex);

Default Value

''

Remarks

The type of email address.

This property classifies the email address. Common values include work, home, and other.

The $useremailindex parameter specifies the index of the item in the array. The size of the array is controlled by the UserEmailCount property.

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

Data Type

String

UserEmailPrimary Property (CloudSSO_SCIMDesktop Class)

Whether this is the primary email address.

Object Oriented Interface

public function getUserEmailPrimary($useremailindex);

Procedural Interface

cloudsso_scimdesktop_get($res, 48, $useremailindex);

Default Value

false

Remarks

Whether this is the primary email address.

This property indicates whether this email address is the user's primary address. Only one entry in the collection should have Primary set to true.

The $useremailindex parameter specifies the index of the item in the array. The size of the array is controlled by the UserEmailCount property.

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

Data Type

Boolean

UserExtensionCostCenter Property (CloudSSO_SCIMDesktop Class)

The user's cost center.

Object Oriented Interface

public function getUserExtensionCostCenter();

Procedural Interface

cloudsso_scimdesktop_get($res, 49);

Default Value

''

Remarks

The user's cost center.

This property identifies the cost center the user is associated with.

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

Data Type

String

UserExtensionDepartment Property (CloudSSO_SCIMDesktop Class)

The user's department.

Object Oriented Interface

public function getUserExtensionDepartment();

Procedural Interface

cloudsso_scimdesktop_get($res, 50);

Default Value

''

Remarks

The user's department.

This property contains the name of the department the user belongs to.

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

Data Type

String

UserExtensionDivision Property (CloudSSO_SCIMDesktop Class)

The user's division.

Object Oriented Interface

public function getUserExtensionDivision();

Procedural Interface

cloudsso_scimdesktop_get($res, 51);

Default Value

''

Remarks

The user's division.

This property contains the name of the division the user belongs to within the organization.

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

Data Type

String

UserExtensionEmployeeNumber Property (CloudSSO_SCIMDesktop Class)

The user's employee number.

Object Oriented Interface

public function getUserExtensionEmployeeNumber();

Procedural Interface

cloudsso_scimdesktop_get($res, 52);

Default Value

''

Remarks

The user's employee number.

This property contains a string identifier for the user within the organization, such as a payroll or HR system identifier.

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

Data Type

String

UserExtensionManagerDisplayName Property (CloudSSO_SCIMDesktop Class)

The display name of the user's manager.

Object Oriented Interface

public function getUserExtensionManagerDisplayName();

Procedural Interface

cloudsso_scimdesktop_get($res, 53);

Default Value

''

Remarks

The display name of the user's manager.

This property contains the human-readable name of the manager. It corresponds to the displayName sub-attribute of the manager complex attribute in the enterprise extension schema.

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

Data Type

String

UserExtensionManagerId Property (CloudSSO_SCIMDesktop Class)

The user identifier of the user's manager.

Object Oriented Interface

public function getUserExtensionManagerId();

Procedural Interface

cloudsso_scimdesktop_get($res, 54);

Default Value

''

Remarks

The user identifier of the user's manager.

This property contains the identifier of the manager's user resource within the application. It corresponds to the value sub-attribute of the manager complex attribute in the enterprise extension schema.

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

Data Type

String

UserExtensionManagerRef Property (CloudSSO_SCIMDesktop Class)

The URI of the manager's user resource.

Object Oriented Interface

public function getUserExtensionManagerRef();

Procedural Interface

cloudsso_scimdesktop_get($res, 55);

Default Value

''

Remarks

The URI of the manager's user resource.

This property contains the full URI reference to the manager's user resource (e.g., /scim/v2/Users/{id}). It corresponds to the $ref sub-attribute of the manager complex attribute in the enterprise extension schema.

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

Data Type

String

UserExtensionOrganization Property (CloudSSO_SCIMDesktop Class)

The user's organization.

Object Oriented Interface

public function getUserExtensionOrganization();

Procedural Interface

cloudsso_scimdesktop_get($res, 56);

Default Value

''

Remarks

The user's organization.

This property contains the name of the organization the user belongs to.

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

Data Type

String

UserPhoneCount Property (CloudSSO_SCIMDesktop Class)

The number of records in the UserPhone arrays.

Object Oriented Interface

public function getUserPhoneCount();

Procedural Interface

cloudsso_scimdesktop_get($res, 57);

Default Value

0

Remarks

This property controls the size of the following arrays:

• UserPhoneNumber
• UserPhonePrimary
• UserPhoneType

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

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

Data Type

Integer

UserPhoneNumber Property (CloudSSO_SCIMDesktop Class)

The phone number.

Object Oriented Interface

public function getUserPhoneNumber($userphoneindex);

Procedural Interface

cloudsso_scimdesktop_get($res, 58, $userphoneindex);

Default Value

''

Remarks

The phone number.

This property contains the phone number value.

The $userphoneindex parameter specifies the index of the item in the array. The size of the array is controlled by the UserPhoneCount property.

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

Data Type

String

UserPhoneType Property (CloudSSO_SCIMDesktop Class)

The type of phone number.

Object Oriented Interface

public function getUserPhoneType($userphoneindex);

Procedural Interface

cloudsso_scimdesktop_get($res, 59, $userphoneindex);

Default Value

''

Remarks

The type of phone number.

This property classifies the phone number. Common values include work, mobile, home, and other.

The $userphoneindex parameter specifies the index of the item in the array. The size of the array is controlled by the UserPhoneCount property.

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

Data Type

String

UserPhonePrimary Property (CloudSSO_SCIMDesktop Class)

Whether this is the primary phone number.

Object Oriented Interface

public function getUserPhonePrimary($userphoneindex);

Procedural Interface

cloudsso_scimdesktop_get($res, 60, $userphoneindex);

Default Value

false

Remarks

Whether this is the primary phone number.

This property indicates whether this phone number is the user's primary number. Only one entry in the collection should have Primary set to true.

The $userphoneindex parameter specifies the index of the item in the array. The size of the array is controlled by the UserPhoneCount property.

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

Data Type

Boolean

AddGroup Method (CloudSSO_SCIMDesktop Class)

Adds a group entry to the outgoing list response.

Object Oriented Interface

public function doAddGroup($groupid, $displayname, $externalid);

Procedural Interface

cloudsso_scimdesktop_do_addgroup($res, $groupid, $displayname, $externalid);

Remarks

This method should be called within a ListGroups event handler once for each group in the current page of results. The class then assembles all added entries into the SCIM ListResponse envelope.

GroupId is the unique identifier for the group, and DisplayName may be empty if not available.

The stored ExternalId should be passed for the group (or "" (empty string) if not recorded).

After all entries have been added, the TotalResults event parameter should be set to the total number of matching groups across all pages, which may be greater than the number of entries added in the current method call.

scim.OnListGroups += (sender, e) => { var page = db.QueryGroups(e.FilterAttribute, e.FilterOperator, e.FilterValue, e.StartIndex - 1, e.Count); foreach (var group in page.Results) { scim.AddGroup(group.Id, group.DisplayName, group.ExternalId); } e.TotalResults = page.TotalCount; e.StatusCode = 200; };

AddGroupMember Method (CloudSSO_SCIMDesktop Class)

Adds a member to the outgoing group response.

Object Oriented Interface

public function doAddGroupMember($groupid, $memberid, $memberdisplay);

Procedural Interface

cloudsso_scimdesktop_do_addgroupmember($res, $groupid, $memberid, $memberdisplay);

Remarks

This method should be called within a GetGroup or ListGroups event handler once for each group member to be included in the SCIM response.

GroupId identifies the group to which the member belongs, and MemberId and MemberDisplay represent the SCIM resource ID and display name of the member user, respectively.

scim.OnGetGroup += (sender, e) => { var group = db.FindGroup(e.GroupId); e.DisplayName = group.DisplayName; e.ExternalId = group.ExternalId; foreach (var member in group.Members) { scim.AddGroupMember(e.GroupId, member.UserId, member.DisplayName); } e.StatusCode = 200; };

AddUser Method (CloudSSO_SCIMDesktop Class)

Adds a user entry to the outgoing list response.

Object Oriented Interface

public function doAddUser($userid, $username, $displayname, $externalid, $active);

Procedural Interface

cloudsso_scimdesktop_do_adduser($res, $userid, $username, $displayname, $externalid, $active);

Remarks

This method should be called within a ListUsers event handler once for each user in the current page of results. The class then assembles all added entries into the SCIM ListResponse envelope.

UserId is the unique identifier for the user, UserName is the user's SCIM username, and DisplayName may be empty if not available.

The stored ExternalId should be passed for the user (or "" (empty string) if not recorded). Active indicates whether the user account is enabled.

After all entries have been added, the TotalResults event parameter should be set to the total number of matching users across all pages, which may be greater than the number of entries added in the current method call.

void scim_ListUsers(object sender, SCIMDesktopListUsersEventArgs e) { var results = db.QueryUsers(e.FilterAttribute, e.FilterOperator, e.FilterValue, e.StartIndex - 1, e.Count); foreach (var user in results.Page) scim.AddUser(user.Id, user.UserName, user.DisplayName, user.ExternalId, user.Active); e.TotalResults = results.TotalCount; e.StatusCode = 0; }

AddUserEmail Method (CloudSSO_SCIMDesktop Class)

Adds an email address to the outgoing user response.

Object Oriented Interface

public function doAddUserEmail($userid, $address, $emailtype, $primary);

Procedural Interface

cloudsso_scimdesktop_do_adduseremail($res, $userid, $address, $emailtype, $primary);

Remarks

This method should be called within a GetUser or ListUsers event handler once for each user's email address to be included in the response.

UserId identifies which user the address belongs to. Address is the email address string, and EmailType classifies the address (common values include work, home, and other). Primary should be set to true only for the user's primary address.

scim.OnGetUser += (sender, e) => { var user = db.FindUser(e.UserId); e.UserName = user.UserName; e.DisplayName = user.DisplayName; e.Active = user.Active; foreach (var email in user.Emails) { scim.AddUserEmail(e.UserId, email.Address, email.EmailType, email.Primary); } e.StatusCode = 200; };

AddUserExtension Method (CloudSSO_SCIMDesktop Class)

Adds enterprise extension attributes to the outgoing user response.

Object Oriented Interface

public function doAddUserExtension($userid, $department, $employeenumber, $costcenter, $organization, $division, $managerid, $managerref, $managerdisplayname);

Procedural Interface

cloudsso_scimdesktop_do_adduserextension($res, $userid, $department, $employeenumber, $costcenter, $organization, $division, $managerid, $managerref, $managerdisplayname);

Remarks

This method should be called within a GetUser or ListUsers event handler once for each user's enterprise extension data to be included in the response.

UserId identifies which user the data belongs to. Department, EmployeeNumber, CostCenter, Organization, and Division are the enterprise user attributes.

ManagerId is the user identifier of the user's manager, ManagerRef is the full URI of the manager's user resource, and ManagerDisplayName is the manager's display name.

"" (empty string) should be passed for any attribute that is not applicable or not stored.

scim.OnGetUser += (sender, e) => { var user = db.FindUser(e.UserId); e.UserName = user.UserName; e.DisplayName = user.DisplayName; e.Active = user.Active; if (user.HasManager) { scim.AddUserExtension(e.UserId, user.Department, user.EmployeeNumber, user.CostCenter, user.Organization, user.Division, user.ManagerId, "", user.ManagerDisplayName); } e.StatusCode = 200; };

The class natively supports the SCIM enterprise user extension schema (urn:ietf:params:scim:schemas:extension:enterprise:2.0:User). The extension schema namespace is handled internally. The API exposes extension attributes directly without requiring the URN to be specified. Additional extension schemas may be supported in future releases.

AddUserPhone Method (CloudSSO_SCIMDesktop Class)

Adds a phone number to the outgoing user response.

Object Oriented Interface

public function doAddUserPhone($userid, $number, $phonetype, $primary);

Procedural Interface

cloudsso_scimdesktop_do_adduserphone($res, $userid, $number, $phonetype, $primary);

Remarks

This method should be called within a GetUser or ListUsers event handler once for each user's phone number to be included in the response.

UserId identifies which user the number belongs to. Number is the phone number string, and PhoneType classifies the number (common values include work, mobile, home, and other). Primary should be set to true only for the user's primary number.

scim.OnGetUser += (sender, e) => { var user = db.FindUser(e.UserId); e.UserName = user.UserName; e.DisplayName = user.DisplayName; e.Active = user.Active; foreach (var phone in user.Phones) { scim.AddUserPhone(e.UserId, phone.Number, phone.PhoneType, phone.Primary); } e.StatusCode = 200; };

Config Method (CloudSSO_SCIMDesktop Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

cloudsso_scimdesktop_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Disconnect Method (CloudSSO_SCIMDesktop Class)

This method disconnects the specified client.

Object Oriented Interface

public function doDisconnect($connectionid);

Procedural Interface

cloudsso_scimdesktop_do_disconnect($res, $connectionid);

Remarks

Calling this method will disconnect the client specified by the ConnectionId parameter.

DoEvents Method (CloudSSO_SCIMDesktop Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

cloudsso_scimdesktop_do_doevents($res);

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Reset Method (CloudSSO_SCIMDesktop Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudsso_scimdesktop_do_reset($res);

Remarks

This method will reset the class's properties to their default values.

Shutdown Method (CloudSSO_SCIMDesktop Class)

This method shuts down the server.

Object Oriented Interface

public function doShutdown();

Procedural Interface

cloudsso_scimdesktop_do_shutdown($res);

Remarks

This method shuts down the server. Calling this method is equivalent to calling StopListening and then breaking every client connection by calling Disconnect.

StartListening Method (CloudSSO_SCIMDesktop Class)

This method starts listening for incoming connections.

Object Oriented Interface

public function doStartListening();

Procedural Interface

cloudsso_scimdesktop_do_startlistening($res);

Remarks

This method begins listening for incoming connections on the port specified by LocalPort. Once listening, events will fire as new clients connect and data are transferred.

To stop listening for new connections, call StopListening. To stop listening for new connections and to disconnect all existing clients, call Shutdown.

StopListening Method (CloudSSO_SCIMDesktop Class)

This method stops listening for new connections.

Object Oriented Interface

public function doStopListening();

Procedural Interface

cloudsso_scimdesktop_do_stoplistening($res);

Remarks

This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

To stop listening and to disconnect all existing clients, call Shutdown instead.

AuthRequest Event (CloudSSO_SCIMDesktop Class)

Fired for every incoming request to control access to specific endpoints.

Object Oriented Interface

public function fireAuthRequest($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 1, array($this, 'fireAuthRequest'));

Parameter List

'connectionid'
'authmethod'
'user'
'token'
'accept'

Remarks

This event fires for every incoming request before any resource event is raised, allowing the application to implement custom authentication logic.

The AuthMethod parameter identifies the authentication scheme supplied by the client.

The Accept value may be changed when additional logic outside of the class is required (e.g., to enforce token expiry, check a revocation list, or accept an alternative authentication scheme).

Requests rejected by this event receive a 401 Unauthorized response.

The ConnectionId parameter identifies the client connection. The value is first provided by the Connected event and may be used to correlate events that are fired for the same connection.

Note that this event fires for every incoming request.

Custom validation covering multiple authentication schemes may be performed as shown.

scim.OnAuthRequest += (sender, e) => { if (e.AuthMethod == "Bearer") { e.Accept = tokenStore.IsValid(e.Token); } else if (e.AuthMethod == "Basic") { e.Accept = userStore.CheckPassword(e.User, e.Token); } else { e.Accept = false; } };

Connected Event (CloudSSO_SCIMDesktop Class)

This event is fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 2, array($this, 'fireConnected'));

Parameter List

'connectionid'
'statuscode'
'description'

Remarks

If the connection is made normally, StatusCode is 0, and Description is "OK".

If the connection fails, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

ConnectionRequest Event (CloudSSO_SCIMDesktop Class)

This event is fired when a request for connection comes from a remote host.

Object Oriented Interface

public function fireConnectionRequest($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 3, array($this, 'fireConnectionRequest'));

Parameter List

'address'
'port'
'accept'

Remarks

This event indicates an incoming connection. The connection is accepted by default. Address and Port will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the Accept parameter to False.

CreateGroup Event (CloudSSO_SCIMDesktop Class)

Fired when a request to create a new group is received.

Object Oriented Interface

public function fireCreateGroup($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 4, array($this, 'fireCreateGroup'));

Parameter List

'connectionid'
'externalid'
'displayname'
'groupid'
'statuscode'

Remarks

This event fires when the class receives a POST /Groups request from the Identity Provider. The inbound group attributes are provided as event parameters.

If the Identity Provider included an externalId in the request, it is made available in the ExternalId parameter. This value should be stored alongside the group record so it can be returned in future GetGroup event responses.

If the request includes group members, they are made available via the GroupMembers collection, where each entry exposes a MemberId and MemberDisplay property.

If the group is created successfully, the GroupId parameter must be set to the newly assigned identifier, and the StatusCode parameter must be set to 201. The full created resource is returned to the Identity Provider in the 201 Created response body. To signal an error, StatusCode must be set to the appropriate HTTP status code (e.g., 409 for a duplicate group). The StatusCode parameter defaults to 500, and a value of 0 is treated as 201.

The ConnectionId parameter identifies the client connection. The value is first provided by the Connected event and may be used to correlate events that are fired for the same connection.

CreateUser Event (CloudSSO_SCIMDesktop Class)

Fired when a request to create a new user is received.

Object Oriented Interface

public function fireCreateUser($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 5, array($this, 'fireCreateUser'));

Parameter List

'connectionid'
'externalid'
'username'
'givenname'
'familyname'
'displayname'
'active'
'userid'
'statuscode'

Remarks

This event fires when the class receives a POST /Users request from the Identity Provider. The inbound user attributes are provided as event parameters.

If the Identity Provider included an externalId in the request, it is made available in the ExternalId parameter. This value should be stored alongside the user record so it can be returned in future GetUser event responses.

The Active parameter indicates whether the new user account should be enabled. If the Identity Provider does not include an active attribute in the request, Active defaults to true.

Email addresses and phone numbers supplied in the request are made available via the UserEmails and UserPhones collections, where each entry exposes an Address, EmailType, and Primary property (for emails) or a Number, PhoneType, and Primary property (for phones). If the Identity Provider included enterprise extension attributes in the request, they are also made available via the UserExtension property.

If the user is created successfully, the UserId parameter must be set to the newly assigned identifier, and the StatusCode parameter must be set to 201. The full created resource is returned to the Identity Provider in the 201 Created response body. To signal an error, StatusCode must be set to the appropriate HTTP status code (e.g., 409 for a duplicate user). The StatusCode parameter defaults to 500, and a value of 0 is treated as 201.

The ConnectionId parameter identifies the client connection. The value is first provided by the Connected event and may be used to correlate events that are fired for the same connection.

DeleteGroup Event (CloudSSO_SCIMDesktop Class)

Fired when a request to delete a group is received.

Object Oriented Interface

public function fireDeleteGroup($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 6, array($this, 'fireDeleteGroup'));

Parameter List

'connectionid'
'groupid'
'statuscode'

Remarks

This event fires when the class receives a DELETE /Groups/{id} request from the Identity Provider. The GroupId parameter identifies the group to delete.

If the deletion is successful, the StatusCode parameter must be set to 204. The class then returns a 204 No Content response. If the group is not found, StatusCode must be set to 404. The StatusCode parameter defaults to 500, and a value of 0 is treated as 204.

The ConnectionId parameter identifies the client connection. The value is first provided by the Connected event and may be used to correlate events that are fired for the same connection.

DeleteUser Event (CloudSSO_SCIMDesktop Class)

Fired when a request to delete a user is received.

Object Oriented Interface

public function fireDeleteUser($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 7, array($this, 'fireDeleteUser'));

Parameter List

'connectionid'
'userid'
'statuscode'

Remarks

This event fires when the class receives a DELETE /Users/{id} request from the Identity Provider. The UserId parameter identifies the user to delete.

If the deletion is successful, the StatusCode parameter must be set to 204. The class then returns a 204 No Content response. If the user is not found, StatusCode must be set to 404. The StatusCode parameter defaults to 500, and a value of 0 is treated as 204.

The ConnectionId parameter identifies the client connection. The value is first provided by the Connected event and may be used to correlate events that are fired for the same connection.

Disconnected Event (CloudSSO_SCIMDesktop Class)

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 8, array($this, 'fireDisconnected'));

Parameter List

'connectionid'
'statuscode'
'description'

Remarks

If the connection is broken normally, StatusCode is 0, and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

Error Event (CloudSSO_SCIMDesktop Class)

This event fires information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 9, array($this, 'fireError'));

Parameter List

'connectionid'
'errorcode'
'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally, the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

ConnectionId indicates the connection for which the error is applicable.

This event also fires when the class rejects a SCIM request, immediately before the error response is returned to the Identity Provider. This includes requests the class itself rejects, such as a malformed request body or a failed authentication. It also includes requests an application event handler rejects by setting its StatusCode parameter to 400 or higher. Those requests report the generic error code 1.

For a rejected SCIM request, Description is the message carried in the detail field of the SCIM error response body. The HTTP status and the response body have already been determined by the time the event fires, so a handler cannot change what is returned to the Identity Provider.

GetGroup Event (CloudSSO_SCIMDesktop Class)

Fired when a request to retrieve a group is received, before a PATCH group update, or when ETags are enabled and a PUT or DELETE request includes an If-Match header.

Object Oriented Interface

public function fireGetGroup($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 10, array($this, 'fireGetGroup'));

Parameter List

'connectionid'
'groupid'
'externalid'
'displayname'
'statuscode'

Remarks

This event fires when the class receives a GET /Groups/{id} request from the Identity Provider. It also fires before processing a PATCH /Groups/{id} request, or when the ETagEnabled configuration setting is true and a PUT /Groups/{id} or DELETE /Groups/{id} request includes an If-Match header. The GroupId parameter identifies the group to retrieve.

The DisplayName must be set to the group's display name. If an ExternalId was stored for this group, it must be set as well. To include group members in the response, the AddGroupMember method should be called once for each member. This event must supply the full group for a PATCH request to work correctly.

When the group is found, the StatusCode parameter must be set to 200. If the group is not found, StatusCode must be set to 404.

The RequestType property may be used to determine whether this event was fired by a direct GET request or internally before a PATCH or a conditional PUT/DELETE.

The StatusCode parameter defaults to 500, and a value of 0 is treated as 200.

The ConnectionId parameter identifies the client connection. The value is first provided by the Connected event and may be used to correlate events that are fired for the same connection.

GetResourceTypes Event (CloudSSO_SCIMDesktop Class)

Fired when a request for the resource type definitions is received.

Object Oriented Interface

public function fireGetResourceTypes($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 11, array($this, 'fireGetResourceTypes'));

Parameter List

'connectionid'
'responsebody'

Remarks

This event fires when the class receives a GET /ResourceTypes request from the Identity Provider. The class returns the standard SCIM User and Group resource type definitions automatically and populates the ResponseBody parameter with the serialized JSON before firing this event.

This event is informational and may be used to log or audit discovery requests and inspect the generated response.

The ConnectionId parameter identifies the client connection. The value is first provided by the Connected event and may be used to correlate events that are fired for the same connection.

GetSchemas Event (CloudSSO_SCIMDesktop Class)

Fired when a request for the schema definitions is received.

Object Oriented Interface

public function fireGetSchemas($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 12, array($this, 'fireGetSchemas'));

Parameter List

'connectionid'
'responsebody'

Remarks

This event fires when the class receives a GET /Schemas request from the Identity Provider. The class returns the standard SCIM User and Group schema definitions, including the enterprise user extension, automatically and populates the ResponseBody parameter with the serialized JSON before firing this event.

This event is informational and may be used to log or audit discovery requests and inspect the generated response.

The ConnectionId parameter identifies the client connection. The value is first provided by the Connected event and may be used to correlate events that are fired for the same connection.

GetServiceProviderConfig Event (CloudSSO_SCIMDesktop Class)

Fired when a request for the service provider configuration is received.

Object Oriented Interface

public function fireGetServiceProviderConfig($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 13, array($this, 'fireGetServiceProviderConfig'));

Parameter List

'connectionid'
'responsebody'

Remarks

This event fires when the class receives a GET /ServiceProviderConfig request from the Identity Provider. The class generates the configuration document automatically based on the SupportedOperations and MaxResults properties and populates the ResponseBody parameter with the serialized JSON before firing this event.

This event is informational and may be used to log or audit discovery requests and inspect the generated response.

The ConnectionId parameter identifies the client connection. The value is first provided by the Connected event and may be used to correlate events that are fired for the same connection.

GetUser Event (CloudSSO_SCIMDesktop Class)

Fired when a request to retrieve a user is received, before a PATCH user update, or when ETags are enabled and a PUT or DELETE request includes an If-Match header.

Object Oriented Interface

public function fireGetUser($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 14, array($this, 'fireGetUser'));

Parameter List

'connectionid'
'userid'
'externalid'
'username'
'givenname'
'familyname'
'displayname'
'active'
'statuscode'

Remarks

This event fires when the class receives a GET /Users/{id} request from the Identity Provider. It also fires before processing a PATCH /Users/{id} request, or when the ETagEnabled configuration setting is true and a PUT /Users/{id} or DELETE /Users/{id} request includes an If-Match header. The UserId parameter identifies the user to retrieve.

The output parameters (i.e., UserName, GivenName, FamilyName, DisplayName, Active) must be set to the current user data. If an ExternalId was stored for this user, it must be set as well. To include email addresses, phone numbers, and enterprise extension data in the response, the AddUserEmail, AddUserPhone, and AddUserExtension methods should be called once for each address, number, and user with extension data on record. This event must supply the full user for a PATCH request to work correctly.

When the user is found, the StatusCode parameter must be set to 200. If the user is not found, StatusCode must be set to 404.

The RequestType property may be used to determine whether this event was fired by a direct GET request or internally before a PATCH or a conditional PUT/DELETE.

The StatusCode parameter defaults to 500, and a value of 0 is treated as 200.

The ConnectionId parameter identifies the client connection. The value is first provided by the Connected event and may be used to correlate events that are fired for the same connection.

ListGroups Event (CloudSSO_SCIMDesktop Class)

Fired when a request to list groups is received.

Object Oriented Interface

public function fireListGroups($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 15, array($this, 'fireListGroups'));

Parameter List

'connectionid'
'filter'
'filterattribute'
'filteroperator'
'filtervalue'
'startindex'
'count'
'totalresults'
'statuscode'

Remarks

This event fires when the class receives a GET /Groups request from the Identity Provider. The Filter parameter contains the raw SCIM filter expression from the request, or "" (empty string) if no filter was specified. For simple single-term filters (e.g., displayName eq "Admins"), the FilterAttribute, FilterOperator, and FilterValue parameters are also populated with the parsed components for convenience. For compound or nested filter expressions, only Filter is populated. The application must parse it directly.

The StartIndex and Count parameters reflect the pagination values from the request. StartIndex is 1-based, and Count is capped by the value of the MaxResults property. When the Identity Provider does not include a count parameter, Count defaults to MaxResults. The application should use these values to query its data source and return only the matching page of results. The sortBy and sortOrder query parameters are not currently supported and are ignored when received.

The AddGroup method must be called once for each group in the current page of results, after which the TotalResults parameter must be set to the total number of matching groups across all pages. To include members for each group, the AddGroupMember method may be called as needed. The StatusCode must be set to 200 when the operation succeeds.

To signal an error, StatusCode must be set to the appropriate HTTP status code. The StatusCode parameter defaults to 500, and a value of 0 is treated as 200.

The ConnectionId parameter identifies the client connection. The value is first provided by the Connected event and may be used to correlate events that are fired for the same connection.

ListUsers Event (CloudSSO_SCIMDesktop Class)

Fired when a request to list users is received.

Object Oriented Interface

public function fireListUsers($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 16, array($this, 'fireListUsers'));

Parameter List

'connectionid'
'filter'
'filterattribute'
'filteroperator'
'filtervalue'
'startindex'
'count'
'totalresults'
'statuscode'

Remarks

This event fires when the class receives a GET /Users request from the Identity Provider. The Filter parameter contains the raw SCIM filter expression from the request, or "" (empty string) if no filter was specified. For simple single-term filters (e.g., userName eq "jsmith"), the FilterAttribute, FilterOperator, and FilterValue parameters are also populated with the parsed components for convenience. For compound or nested filter expressions, only Filter is populated. The application must parse it directly.

The StartIndex and Count parameters reflect the pagination values from the request. StartIndex is 1-based, and Count is capped by the value of the MaxResults property. When the Identity Provider does not include a count parameter, Count defaults to MaxResults. The application should use these values to query its data source and return only the matching page of results. The sortBy and sortOrder query parameters are not currently supported and are ignored when received.

The AddUser method must be called once for each user in the current page of results. To include email addresses, phone numbers, or enterprise extension data for each user, the AddUserEmail, AddUserPhone, and AddUserExtension methods may be called as needed. After all users have been added, the TotalResults parameter must be set to the total number of matching users across all pages. This value may be greater than Count if the result set is paginated. The StatusCode must be set to 200 when the operation succeeds.

To signal an error, StatusCode must be set to the appropriate HTTP status code. The StatusCode parameter defaults to 500, and a value of 0 is treated as 200.

The ConnectionId parameter identifies the client connection. The value is first provided by the Connected event and may be used to correlate events that are fired for the same connection.

Log Event (CloudSSO_SCIMDesktop Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 17, array($this, 'fireLog'));

Parameter List

'connectionid'
'loglevel'
'message'
'logtype'

Remarks

This event fires once for each log message generated by the class while it processes a SCIM request. This includes messages from the built-in HTTP server about the HTTP messages exchanged with the Identity Provider. The verbosity is controlled by the LogLevel configuration setting.

LogLevel indicates the level of the message. Possible values are as follows:

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "SCIM": Messages about processing the SCIM request, such as the authentication result and the event being invoked.
• "HTTPConnection": The HTTP messages exchanged with the Identity Provider.

The ConnectionId parameter identifies the client connection. The value is first provided by the Connected event and may be used to correlate events that are fired for the same connection.

SSLClientAuthentication Event (CloudSSO_SCIMDesktop Class)

This event is fired when the client presents its credentials to the server.

Object Oriented Interface

public function fireSSLClientAuthentication($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 18, array($this, 'fireSSLClientAuthentication'));

Parameter List

'connectionid'
'certencoded'
'certsubject'
'certissuer'
'status'
'accept'

Remarks

This event enables the server to decide whether or not to continue. The Accept parameter is a recommendation on whether to continue or to close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").

SSLConnectionRequest Event (CloudSSO_SCIMDesktop Class)

This event fires when a Secure Sockets Layer (SSL) connection is requested.

Object Oriented Interface

public function fireSSLConnectionRequest($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 19, array($this, 'fireSSLConnectionRequest'));

Parameter List

'connectionid'
'supportedciphersuites'
'supportedsignaturealgs'
'certstoretype'
'certstore'
'certpassword'
'certsubject'

Remarks

This event fires when an SSL connection is requested and SSLProvider is set to Internal. This event provides an opportunity to select an alternative certificate to the connecting client. This event does not fire when SSLProvider is set to Platform.

This event allows the class to be configured to use both RSA and ECDSA certificates depending on the connecting client's capabilities.

ConnectionId is the connection Id of the client requesting the connection.

SupportedCipherSuites is a comma-separated list of cipher suites that the client supports.

SupportedSignatureAlgs is a comma-separated list of certificate signature algorithms that the client supports.

CertStoreType is the store type of the alternate certificate to use for this connection. The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

CertStore is the store name or location of the alternate certificate to use for this connection.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

CertPassword is the password of the certificate store containing the alternate certificate to use for this connection.

CertSubject is the subject of the alternate certificate to use for this connection.

The special value * matches any subject and will select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

SSLStatus Event (CloudSSO_SCIMDesktop Class)

This event is fired to show the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 20, array($this, 'fireSSLStatus'));

Parameter List

'connectionid'
'message'

Remarks

The event is fired for informational and logging purposes only. It is used to track the progress of the connection.

UpdateGroup Event (CloudSSO_SCIMDesktop Class)

Fired after the current group has been loaded and a replace or update request has been applied.

Object Oriented Interface

public function fireUpdateGroup($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 21, array($this, 'fireUpdateGroup'));

Parameter List

'connectionid'
'groupid'
'externalid'
'displayname'
'statuscode'

Remarks

This event fires when the class receives a PUT /Groups/{id} or PATCH /Groups/{id} request from the Identity Provider. For PUT, the event parameters reflect the full group representation from the request body directly. For PATCH, the class first retrieves the current group via the GetGroup event, applies the patch operations, then fires this event.

For a PUT request, the ExternalId parameter contains the externalId value from the request body, or "" (empty string) if not provided.

For a PUT request, the provided DisplayName and member list should be applied to the group identified by GroupId, and any attributes not present in the request should be cleared. For a PATCH request, the event parameters likewise reflect the complete final group, with the values loaded through the GetGroup event and the patch operations applied on top. All parameters should be applied in the same way, since any attribute the patch did not touch carries its original value.

Updated members are made available via the GroupMembers collection. The collection always reflects the full current member list after the request is applied. All stored members should be replaced with the collection contents.

When the update succeeds, StatusCode must be set to 200. It may also be set to 204, which is valid when the updated resource does not need to be returned, causing the class to return a 204 No Content response with no body. Some Identity Providers require a 200 response with the updated resource body. Check your Identity Provider's SCIM implementation guide before returning 204. If the group is not found, StatusCode must be set to 404. The StatusCode parameter defaults to 500, and a value of 0 is treated as 200.

The ConnectionId parameter identifies the client connection. The value is first provided by the Connected event and may be used to correlate events that are fired for the same connection.

UpdateUser Event (CloudSSO_SCIMDesktop Class)

Fired after the current user has been loaded and a replace or update request has been applied.

Object Oriented Interface

public function fireUpdateUser($param);

Procedural Interface

cloudsso_scimdesktop_register_callback($res, 22, array($this, 'fireUpdateUser'));

Parameter List

'connectionid'
'userid'
'externalid'
'username'
'givenname'
'familyname'
'displayname'
'active'
'statuscode'

Remarks

This event fires when the class receives a PUT /Users/{id} or PATCH /Users/{id} request from the Identity Provider. For PUT, the event parameters reflect the full user representation from the request body directly. For PATCH, the class first retrieves the current user via the GetUser event, applies the patch operations, then fires this event.

For a PUT request, the ExternalId parameter contains the externalId value from the request body, or "" (empty string) if not provided.

For a PUT request, all event parameters should be applied to the user identified by UserId, and any attributes not present in the request should be cleared. For a PATCH request, the event parameters likewise reflect the complete final user, with the values loaded through the GetUser event and the patch operations applied on top. All parameters should be applied in the same way, since any attribute the patch did not touch carries its original value.

The Active parameter reflects the user's active state. For a PUT request, Active defaults to true if active is absent from the request body.

Email addresses and phone numbers are made available via the UserEmails and UserPhones collections. The collections always reflect the full current state of the user after the request is applied. All stored entries should be replaced with the collection contents. Enterprise extension attributes are made available via the UserExtension property and likewise reflect the full current state after the request is applied.

When the update succeeds, StatusCode must be set to 200. It may also be set to 204, which is valid when the updated resource does not need to be returned, causing the class to return a 204 No Content response with no body. Some Identity Providers require a 200 response with the updated resource body. Check your Identity Provider's SCIM implementation guide before returning 204. If the user is not found, StatusCode must be set to 404. The StatusCode parameter defaults to 500, and a value of 0 is treated as 200.

The ConnectionId parameter identifies the client connection. The value is first provided by the Connected event and may be used to correlate events that are fired for the same connection.

Config Settings (SCIMDesktop Class)

The class accepts one or more of the following configuration settings . Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

SCIMDesktop Config Settings

Base Config Settings

Trappable Errors (SCIMDesktop Class)

SCIMDesktop Errors

The class may also return one of the following error codes, which are inherited from other classes.