ISSONotification.SendNotification Method

Article
02/02/2021

Sends a notification, such as a password change, from the adapter to the ENTSSO system.

Syntax

  
HRESULT SendNotification(  
SSendNotification SendNotification,  
GUID* pguidTrackingId  
);

Parameters

SendNotification
[in] The notification to send to ENTSSO from the adapter.

pguidTrackingId
[out] When this method returns, contains the tracking ID generated by ENTSSO. You can use the tracking ID for auditing purposes or to correlate request responses. May be NULL.

Return Value

This method returns an HRESULT indicating whether it completed correctly. For more information, see the Error Values section.

Error Values

This method returns an HRESULT containing one of the values in the following table.

Value	Description
S_OK	The method was successful.
E_ACCESSDENIED	Access is denied.
ENTSSO_E_NO_SERVER	Could not contact the ENTSSO server. Check that the ENTSSO service is running.
ENTSSO_E_WRONG_STATE	This method has been called in the wrong state.
ENTSSO_E_INVALID_NOTIFICATION	Invalid notification type.

Remarks

You can use SendNotification to send password changes and other notifications to the ENTSSO system.

If SendNotification returns S_OK, this does not mean that a password change was completed on the destination system. Instead, receiving an S_OK means ENTSSO has accepted and eventually will complete your request.

A password change from an external system can have several consequences:

If a partial password sync is configured, then the SSO database might be updated, if a current mapping exists for the external account.
If a full password sync is configured, then the password change might also be made to a Windows account.

If the external account has no current mapping in the SSO database, the password change might have no effect.

The password change complete notification is issued when the password change is considered complete from the ENTSSO point-of-view, which as discussed above, could mean different things. In some cases, it could mean no change was done, that only the SSO database was updated, or that the Windows password was changed.

Note that password change complete notifications sent back to the adapter are not completely reliable. Under some error conditions, Single Sign-On may never actually receives the requested notifications.

In ENTSSO, the definition of credentials, such as those sent by SendNotification for password updates, is more flexible than a simple password. When you define an SSO application, you also define the credential fields. The fields identify the labels to use for the UI fields, and whether those fields are masked or not. In addition, there is also a special flage which specifies whether the field should be synchronized or not. Field 0 is a special case and defines the label for the user ID. For more information, see the ISSOAdmin Interface.

Requirements

Platforms: Windows

Share via