Create an SSO connection
curl --request POST \
--url https://api.voucher-staging.allride.io/partner/v1/sso-connections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"protocol": "saml",
"displayName": "Example Transit SSO",
"emailDomains": [
"example-transit.example.com"
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
protocol: 'saml',
displayName: 'Example Transit SSO',
emailDomains: ['example-transit.example.com']
})
};
fetch('https://api.voucher-staging.allride.io/partner/v1/sso-connections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voucher-staging.allride.io/partner/v1/sso-connections"
payload = {
"protocol": "saml",
"displayName": "Example Transit SSO",
"emailDomains": ["example-transit.example.com"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.post("https://api.voucher-staging.allride.io/partner/v1/sso-connections")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"protocol\": \"saml\",\n \"displayName\": \"Example Transit SSO\",\n \"emailDomains\": [\n \"example-transit.example.com\"\n ]\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/partner/v1/sso-connections"
payload := strings.NewReader("{\n \"protocol\": \"saml\",\n \"displayName\": \"Example Transit SSO\",\n \"emailDomains\": [\n \"example-transit.example.com\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voucher-staging.allride.io/partner/v1/sso-connections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'protocol' => 'saml',
'displayName' => 'Example Transit SSO',
'emailDomains' => [
'example-transit.example.com'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"id": 19069,
"resource": "sso-connection",
"partnerId": 1069,
"protocol": "saml",
"identityPlatformProviderId": "saml.example-transit",
"displayName": "Example Transit SSO",
"emailDomains": [
{
"domain": "example-transit.example.com",
"txtName": "_allride-voucher-verification.example-transit.example.com",
"txtValue": "allride-verify=4f0c2b1e9d8a",
"verifiedAt": null,
"lastCheckedAt": null,
"lastError": null
}
],
"status": "draft",
"enforced": false,
"jitProvisioning": true,
"jitDefaultGroupId": 14070,
"idp": {
"entityId": "https://idp.example-transit.example.com/saml",
"ssoUrl": "https://idp.example-transit.example.com/sso",
"certificateFingerprints": [
"5d1c7eaa219b3044f18e0d6a52c39f172b88e4017d63a95ec2104fbb39d67208"
]
},
"serviceProvider": {
"entityId": "https://api.voucher.allride.io/auth/v1/saml/example-transit",
"acsUrl": "https://api.voucher.allride.io/auth/v1/saml/example-transit/acs"
},
"createdAt": "2026-10-22T10:00:00Z",
"updatedAt": "2026-10-22T10:00:00Z",
"_links": {
"self": {
"href": "https://api.voucher.allride.io/partner/v1/sso-connections/19069",
"type": "application/json"
}
}
}
}
Single sign-on
Create an SSO connection
Creates a connection in draft. Publish the returned TXT records and configure serviceProvider in your identity provider, then call :verify. SSO is configured only by dashboard users. See Members and groups.
Required permissions: manage-sso · API keys: not allowed · Recent sign-in: required for dashboard users (15 minutes)
POST
/
partner
/
v1
/
sso-connections
Create an SSO connection
curl --request POST \
--url https://api.voucher-staging.allride.io/partner/v1/sso-connections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"protocol": "saml",
"displayName": "Example Transit SSO",
"emailDomains": [
"example-transit.example.com"
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
protocol: 'saml',
displayName: 'Example Transit SSO',
emailDomains: ['example-transit.example.com']
})
};
fetch('https://api.voucher-staging.allride.io/partner/v1/sso-connections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voucher-staging.allride.io/partner/v1/sso-connections"
payload = {
"protocol": "saml",
"displayName": "Example Transit SSO",
"emailDomains": ["example-transit.example.com"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.post("https://api.voucher-staging.allride.io/partner/v1/sso-connections")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"protocol\": \"saml\",\n \"displayName\": \"Example Transit SSO\",\n \"emailDomains\": [\n \"example-transit.example.com\"\n ]\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/partner/v1/sso-connections"
payload := strings.NewReader("{\n \"protocol\": \"saml\",\n \"displayName\": \"Example Transit SSO\",\n \"emailDomains\": [\n \"example-transit.example.com\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voucher-staging.allride.io/partner/v1/sso-connections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'protocol' => 'saml',
'displayName' => 'Example Transit SSO',
'emailDomains' => [
'example-transit.example.com'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"id": 19069,
"resource": "sso-connection",
"partnerId": 1069,
"protocol": "saml",
"identityPlatformProviderId": "saml.example-transit",
"displayName": "Example Transit SSO",
"emailDomains": [
{
"domain": "example-transit.example.com",
"txtName": "_allride-voucher-verification.example-transit.example.com",
"txtValue": "allride-verify=4f0c2b1e9d8a",
"verifiedAt": null,
"lastCheckedAt": null,
"lastError": null
}
],
"status": "draft",
"enforced": false,
"jitProvisioning": true,
"jitDefaultGroupId": 14070,
"idp": {
"entityId": "https://idp.example-transit.example.com/saml",
"ssoUrl": "https://idp.example-transit.example.com/sso",
"certificateFingerprints": [
"5d1c7eaa219b3044f18e0d6a52c39f172b88e4017d63a95ec2104fbb39d67208"
]
},
"serviceProvider": {
"entityId": "https://api.voucher.allride.io/auth/v1/saml/example-transit",
"acsUrl": "https://api.voucher.allride.io/auth/v1/saml/example-transit/acs"
},
"createdAt": "2026-10-22T10:00:00Z",
"updatedAt": "2026-10-22T10:00:00Z",
"_links": {
"self": {
"href": "https://api.voucher.allride.io/partner/v1/sso-connections/19069",
"type": "application/json"
}
}
}
}
Dashboard session only. API keys cannot call this operation.
Authorizations
Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.
Headers
Optional key (1-255 printable ASCII characters, no spaces; a UUID is ideal) that makes this POST safe to retry: the same key with the same request replays the stored response for 24 hours. See Idempotency.
Required string length:
1 - 255Pattern:
^[\x21-\x7E]{1,255}$Body
application/json
New SSO connection.
Protocol.
Available options:
saml, oidc Name (1-120 characters).
Required string length:
1 - 120Email domains (1-10); public mailbox domains are refused.
Required array length:
1 - 10 elementsSAML settings (required when protocol is saml).
Show child attributes
Show child attributes
OIDC settings (required when protocol is oidc).
Show child attributes
Show child attributes
Create memberships on first sign-in (default false).
Group for provisioned members (not owners or administrators).
Required range:
0 <= x <= 18446744073709552000Response
Created
Single-object envelope around a SsoConnection.
A SAML or OIDC single sign-on connection.
Show child attributes
Show child attributes