Published — v. 7

Single Sign-On

Owned by MailUp Dev Team (Unlicensed)
Last updated: May 29, 2023


Token

If you need to know how to create a token, visists this page Authenticating with OAuth v2 searching for the “Resource Owner Password Grant" paragraph


Restricted feature

Account activation via API is an advanced feature that is disabled by default. It requires manual activation by the MailUp team. Please contact MailUp to have this feature enabled for your application. You will be asked to provide your Client ID



Description

Create a temporary single sign-on URL to log in to your platform as the user provided during the authentication call.

The response contains two fields:

  • the first represents the link to access your platform: embed it in your website!
  • the second represents the validity period of your token; when the token expires, you cannot access your platform using the single sign-on login URL provided.
HTTP MethodPOST
URLhttps://services.mailup.com/api/v1.1/rest/ConsoleService.svc/Console/Sso
ReferenceGo to automated doc
JSON request (example)none
JSON response (example)
 When your integration is enabled: click here to expand...
200 Ok
 
{
    "Link": {
        "href": "https://<your_platform_url>/Console/Login.aspx?Code=1W1c3W2U3e1M1k1R3A3M2K3X2w1U2G2h0d163T1...",
        "rel": "self"
    },
    "ExpiresIn": 600
}
 When your integration is not enabled: click here to expand...
403 Forbidden

{
    "ErrorCode": "403",
    "ErrorDescription": "Authorization error: You cannot generate the MailUp platform login url due to permission issue. Please, contact MailUp for further information.",
    "ErrorName": "Forbidden",
    "ErrorStack": null
}
Paging and filtering (example)