List SSO Integrations
Returns a list of all SSO integrations configured in your account.
Endpoint
GET
v5/sso
Requires authentication
Path Parameters
None
Query Parameters
All query parameters are optional.
page
integer
Page number to return. Defaults to 1.
resultsperpage
integer
Number of results to return per page.
Response
Returns a keyed object of SSO integration objects, where each key is the SSO ID.
result_ok
boolean
Whether the request succeeded.
data
object
Keyed object of SSO integration objects, where each key is the SSO integration ID.
child attributes
id
string
The unique ID of the SSO integration.
name
string
Internal title for the SSO integration (e.g.
Survey Respondent Authentication).type
string
Authentication type. Possible values:
Account, Survey.status
string
Current status of the integration. Possible values:
Active, Closed.entity_id
string
The globally unique URL or string identifying the Identity Provider (IdP) entity.
login
string
The login URL for the IdP. This is where SAML requests are sent.
logout
string
The logout URL for the IdP.
cert_fingerprint
string
Fingerprint of the SSL certificate used by the IdP.
cert_domain
string | null
Domain associated with the certificate, if applicable.
customerid
string
The Alchemer account (customer) ID associated with this integration.
created
string
Timestamp when the SSO integration was created.
dModified
string
Timestamp when the SSO integration was last modified.
creatusers
string
Whether new Alchemer users are automatically created on first SSO login.
"true" or "false".userteam
string
Team ID assigned to newly created users.
"0" if not set.userlicense
string
License ID assigned to newly created users.
"0" if not set.userrole
string
Role ID assigned to newly created users.
usersolo
string
Whether users are restricted to a single active session.
"true" or "false".disable_users
string
Number of weeks of inactivity before a user is disabled.
"0" if not configured.weeks_to_disable
string | null
Specific inactivity threshold in weeks, if set.
force_sso_login
string
Whether SSO login is enforced for users.
"0" = not enforced.email_notification
string | null
Email address for error notifications when creating new users.
null if not set.user_last_modified
string
Timestamp of the last user modification triggered by this integration.
iUserIDCreated
string
ID of the Alchemer user who created this SSO integration.
attributes
array
List of SSO data attribute names mapped for use with Survey authentication type. Empty array if none configured.
sp_metadata
string
URL path to Alchemer's Service Provider (SP) metadata for this integration.
sp_login
string
URL path to Alchemer's SP login endpoint for this integration.
user_deleted
string | null
Timestamp when the associated user was deleted, if applicable.
deleted
string | null
Timestamp when this integration was deleted, if applicable.
Examples
Note GET requests are cached for 60 seconds. Repeated identical requests within that window will return cached results.
Request (cURL)
curl -X GET "https://api.alchemer.com/v5/sso?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET"
Response
{
"result_ok": true,
"data": {
"YOUR_SSO_ID": {
"id": "YOUR_SSO_ID",
"entity_id": "https://example.alchemer.com/adfs/services/trust",
"login": "https://example.alchemer.com/adfs/ls/",
"logout": "https://example.alchemer.com/adfs/ls/",
"cert_fingerprint": "abcd1234efgh5678ijkl9101112",
"customerid": "YOUR_CUSTOMER_ID",
"created": "2017-02-06 15:51:04",
"dModified": "2017-06-22 17:23:43",
"status": "Active",
"cert_domain": null,
"user_last_modified": "0",
"creatusers": "false",
"userteam": "0",
"userlicense": "0",
"userrole": "2",
"iUserIDCreated": "YOUR_USER_ID",
"usersolo": "true",
"email_notification": null,
"disable_users": "0",
"weeks_to_disable": null,
"type": "Survey",
"attributes": [
"Dept",
"Street",
"DisplayName"
],
"name": "Survey Respondent Authentication",
"force_sso_login": "0",
"user_deleted": null,
"deleted": null,
"sp_metadata": "app.alchemer.com/login/getsamlxml/idp/YOUR_SSO_ID",
"sp_login": "app.alchemer.com/ssologin.php?idp=YOUR_SSO_ID"
}
}
}