How to sign users in with Single Sign-On (SSO)

To automatically sign users into Sendible or your white label site, you'll need the following details:

  • Your application_id.
  • The user's username.
  • The user's api_key.

How do I find my users' username and api_key

If you authenticate as the administrator on your account, you can retrieve all users and their API keys by making a call using the Get User Profiles API endpoint.

[
  {
    "api_key": "1e4cde225f8a641b2ff5",
    "id": 3001110,
    "fullname": "John Doe",
    "email": "john1@doe.com",
    "login": "johndoe1",
    "user_status": "Active (Premium)"
  },
  {
    "api_key": "1e4cde225f8a641b2ff5",
    "id": 3001111,
    "fullname": "GavinJohn Doe",
    "email": "john2@doe.com",
    "login": "johndoe2",
    "user_status": "Active (Premium)"
  }
]

To sign on as one of your users, pass the username and api_key of the user using one of the following options.

If you're using Sendible, direct users to the following URL:

https://api.sendible.com/api/v2/auth?application_id=[APPLICATION_ID]&source=sso&username=[USERNAME]&api_key=[APIKEY]&path=[PATH]&redirect_uri=https://app.sendible.com/%23auth

If you're on a white label, direct users to the following URL:

[YOUR_WHITE_LABEL_API_URL]/api/v2/auth?application_id=[APPLICATION_ID]&source=sso&username=[USERNAME]&api_key=[APIKEY]&path=[PATH]&redirect_uri=[YOUR_WHITE_LABEL_APP_URL]/%23auth

Redirecting users after sign in:

path (required)

This is the path within the application to direct the user to after they have been signed in. This can be a relative path. E.g. using a path of /measure will direct users to the reporting area or using / will send them to the default page.