Create SSO Integration
Sets up a new SSO (Single Sign-On) integration in your account.
Endpoint
PUT
v5/sso
Requires authentication
Path Parameters
None
Query Parameters
name
string
required
Internal title for the SSO integration (e.g.
Survey Respondent Authentication).type
string
required
Authentication type. Accepted values:
Account, Survey.entity_id
string
required
The globally unique URL or string identifying your Identity Provider (IdP) entity.
login
string
required
Login URL for the IdP. This is where SAML requests will be sent.
logout
string
required
Logout URL for the IdP.
cert
string
required
The SSL certificate file (
.crt) for your IdP, downloadable from your SSL issuer. If the file includes intermediate or root certificate chains, that is acceptable as long as the main domain certificate is present.status
string
Status of the integration. Accepted values:
Active, Closed.attributes
object
Array of SSO data attributes used with the Survey authentication type. Each key is the attribute name and the value is the attribute value.
child attributes
attribute name
string
An attribute name/value pair to pass through SSO. Example:
attributes[Dept]=Sales. See Using SSO Data Attributes for details.metadataurl
string
Identity Provider metadata URL. Allows Alchemer to pull SAML settings directly from your IdP metadata.
createusers
boolean
If
true, new Alchemer users are automatically created on first SSO login. Accepted values: true, false.userrole
integer
Role ID to assign to newly created users.
userteam
integer
Team ID to assign to newly created users.
userlicense
integer
License ID to assign to newly created users. See license ID reference below.
usersolo
boolean
Whether users are restricted to a single active session. Accepted values:
true, false.userdisable
integer
Number of weeks of inactivity in Alchemer before a user is disabled. Use
0 to disable this feature.notificationemail
string
Email address to notify in the event of errors when creating new SSO users.
License ID reference
| License | ID |
|---|---|
| Reporting | 19 |
| Basic | 3 |
| Standard | 14 |
| HR Professional | 6 |
| Market Research | 16 |
| Educational | 20 |
| Full Access | 7 |
Response
Returns the newly created SSO integration object.
result_ok
boolean
Whether the request succeeded.
data
object
Keyed object containing the newly created SSO integration. The key is the new SSO integration ID. See Get SSO Integration for the full list of response fields.
Examples
Request (cURL)
curl -X PUT "https://api.alchemer.com/v5/sso?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET&name=Survey+Respondent+Authentication&type=Survey&entity_id=https://example.alchemer.com/adfs/services/trust&login=https://example.alchemer.com/adfs/ls/&logout=https://example.alchemer.com/adfs/ls/&cert=-----BEGIN+CERTIFICATE-----%0D%0AMIagh...-----END+CERTIFICATE-----"
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": "1234abcd5678efgh9101112",
"customerid": "YOUR_CUSTOMER_ID",
"created": "2017-02-06 15:51:04",
"dModified": "2017-09-28 17:30:01",
"status": "Active",
"cert_domain": null,
"user_last_modified": "YOUR_USER_ID",
"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"
}
}
}