Single Sign-On Web Service

Description Manages single sign-on information. Namespace http://portwise.com/ws/v1/sso Endpoint https://<hostname>/ws/v1/services/SingleSignOn Style Document/Literal WSDL https://<host>/ws/v1/services/SingleSignOn?wsdl Since 5.2 See also

The single sign-on service manages the SSO user credentials. It operates only on the user for which the subject represents, i.e. to manage a user's SSO credentials you must be authenticated as the user. Also, the user must belong to the SSO domain being managed.

Endpoint Services

Name	getCredential
Description	Retrieves current SSO credentials for the subject on a specific SSO domain.
Input	subject a Subject representing the entity for which to retrieve the SSO credentials. The subject must be authenticated. domain a string with the name of the SSO domain for which to retrieve credentials for.
Output	List<MapItem> containing the credentials configured for the SSO domain.
Since	5.2
Faults	WSException if a general error occurs. SingleSignOnException if SSO retrieval failed.

Name	updateCredential
Description	Adds or updates the SSO credentials for the subject on a specific SSO domain.
Input	subject a Subject representing the entity for which to update the SSO credentials. The subject must be authenticated. domain a string with the name of the SSO domain for which to update credentials on. credentials a List<MapItem> containing the SSO credentials, it must correspond to the configured attributes for the SSO domain. SSO credential keys username password domain
Output	None.
Since	5.2
Faults	WSException if a general error occurs. SingleSignOnException if SSO update failed.

Name	updateCredentialAsAdmin
Description	Administrator adds or updates SSO credentials for the user identity represented by the username on the specified SSO domain.
Input	adminSubject a Subject is the the identity administrator who will update SSO credentials of the user. The adminSubject must be authenticated. username the user name for which to update SSO credentials. domain a string with the name of the SSO domain for which to update credentials on. credentials a List<MapItem> containing the SSO credentials, it must correspond to the configured attributes for the SSO domain. SSO credential keys username password domain
Output	None.
Since	5.13.4
Faults	WSException if a general error occurs. SingleSignOnException if SSO update failed.

Name	deleteCredential
Description	Deletes the SSO credentials for the subject on a specific SSO domain.
Input	subject a Subject representing the entity for which to delete the SSO credentials. The subject must be authenticated. domain a string with the name of the SSO domain for which to delete credentials on.
Output	None.
Since	5.2
Faults	WSException if a general error occurs. SingleSignOnException if SSO deletion failed.

Name	deleteCredentialAsAdmin
Description	Administrator deletes SSO credentials for the user identity represented by the username on the specified SSOdomain.
Input	adminSubject a Subject is the identity of administrator who will delete SSO credentials of the user. The adminSubject must be authenticated. username the user name for which to delete SSO credentials. domain a string with the name of the SSO domain for which to delete credentials on.
Output	None.
Since	5.13.4
Faults	WSException if a general error occurs. SingleSignOnException if SSO deletion failed.

Java Example

Shows how to remove, add and retrieve SSO credentials for a user. Error handling and call to Authenticate omitted.

    List<MapItem> ssoData = new ArrayList<>();

    // Locate single sign-on web service
    SingleSignOnService locator = new SingleSignOnService();
    SingleSignOn service = locator.getSingleSignOn();

    // Configure required SSO credentials
    MapItem username = new MapItem();
    username.setKey("username");
    username.setValue("billy".getBytes(StandardCharsets.UTF_8));
    ssoData.add(username);
    MapItem password = new MapItem();
    password.setKey("password");
    password.setValue("123456".getBytes(StandardCharsets.UTF_8));
    ssoData.add(password);

    // Execute SSO delete
    service.deleteCredential(subject, "SomeSSODomain");

    // Execute SSO update
    service.updateCredential(subject, "SomeSSODomain", ssoData);

    // Execute SSO get
    ssoData = service.getCredential(subject, "SomeSSODomain");

    // Execute SSO update as admin
    service.updateCredentialAsAdmin(adminsubject, "SomeUserName", "SomeSSODomain", ssoData);

    // Execute SSO delete as admin
    service.deleteCredentialAsAdmin(adminsubject, "SomeUserName", "SomeSSODomain");

Copyright © 1999-2023, Technology Nexus Secured Business Solutions AB. All rights reserved.