singleSignOn

Note: This method is deprecated. We now recommend that the EstablishSession endpoint be used in conjunction with getSSOAuthToken. This method may still work when a POST request is made, but POST parameters cannot be included in a redirect. This method uses a single sign-on token to log the site visitor in to the site as a registered user. The user identification is embedded in the token. The token is obtained by the external server by calling the getSingleSignOnToken, login, or authenticateUser API methods.

Client Servlet Server Servlet HTTP Methods Supported Requires Authentication
CRConsAPI None. POST No.

Client API Syntax

https://secure2.convio.net/organization/site/CRConsAPI?method=singleSignOn &api_key=value &v=value [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value ] &sso_auth_token=value [ &remember_me=value ]

Usage Notes

This client-only method logs in a user authenticated by an external system, by passing a valid sso_auth_token returned by getSinglSignOnToken.

Note: Use this API only if the third-party server will authenticate the user. To use Luminate Online as the master authenticator, use login or authenticateUser instead.

See Single Sign On (Luminate Online as client) for additional information on these API methods.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

remember_me

Optional. If set, a log-in cookie is pushed to the browser to recognize the current user on his next visit.

Type xsd:boolean.

Default is false.

Response

See topic HTTP Status Codes.

XML response 
<?xml version="1.0" encoding="UTF-8"?>
<singleSignOnMethodResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">9dlp0oxn21.app8007</singleSignOnMethodResponse>
JSON response 
{"singleSignOnMethodResponse":{"content":"9dlp0oxn21.app8007"}}
Parent topic: Single Sign-on API
Previous topic: logout

Leave a Comment

Nickname
Comment
Enter this word:
Change