Sign in a user via SAML
GET/unified/integration/saml/{workspace_id}/{integration_type} NO AUTH NEEDED
Returns a SAML authentication URL for the specified integration. Once a successful authentication occurs, the name and email are returned inside a jwt parameter, which is a JSON web token that is base-64 encoded.
Parameters
success_redirectstring
The URL where you want the user to be redirect to after a successful authentication/sign-in. A "jwt" parameter will be appended to the URL which will contain a name and email of the user who just signed-in.
failure_redirectstring
The URL where you want the user to be redirect to after an unsuccessful authentication. An "error" variable will be appended.
statestring
Extra state to send back to your success URL
redirectboolean
envstring default=Production
workspace_idstring required
The ID of the workspace
integration_typestring required
Type of the supported integration
Returns
string
Errors
Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).
{
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to unified.to API; max requests per minute: N"
}| Status | Error | Meaning |
|---|---|---|
400 | Bad Request | The request was malformed or failed validation. |
401 | Unauthorized | The connection is likely broken; re-authorize it. |
403 | Forbidden | The connection is missing permissions or scopes. |
404 | Not Found | The requested resource does not exist. |
429 | Too Many Requests | Rate limit exceeded (see the two sources below). |
500 | Internal Server Error | An unexpected error occurred. |
501 | Not Implemented | Not supported by this integration. |
Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.
429 Too Many Requests
A 429 has two possible sources:
- The integration's own rate limit, passed through.
- Unified's workspace limit: a rolling 60 seconds, set by plan, with the message
Too many requests to unified.to API; max requests per minute: N.
const options = {
method: 'GET',
url: 'https://api.unified.to/unified/integration/saml/5dc620c91e139b20430ad8e0/hubspot',
params: {
success_redirect: '',
failure_redirect: '',
state: '',
redirect: false,
env: 'Production',
}
};
const results = await axios.request(options); Are we missing anything? Let us know
Was this page helpful?