v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB

Users

User SSO login

User Signe sign-on login to external application. In this case it is necessary cary SSO token from CareCloud to login user. ⚠️ Endpoint is available only in the Enterprise interface.

post/users/actions/sso-login

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Request body

user_external_application_idstring required

ID of an external application where user wants to be logged in. If you don't have id, please contact your account manager.

sso_tokenstring required

Single sign-on token from CareCloud.

Example request

{
  "user_external_application_id": "89d1a6111b3fb6e74665d948",
  "sso_token": "ae11e710ea4d9495da43c7ae11e71b4e723e7bce494a"
}

Response

Example response

{
  "data": {
    "bearer_token": "09359095c5da43c7ae11e710eabce49418715a6a",
    "valid_to": "2019-01-04 10:31:56",
    "user": {
      "user_id": "838b73aacb5ac326cec4030c80",
      "login": "happy_user",
      "first_name": "Happy",
      "last_name": "User",
      "email": "happy_user@crmcarcloud.com",
      "phone": "420523828931",
      "user_role_ids": [
        "86e05affc7a7befcd513ab400",
        "89ce2a1b9b01f5c939fb1e20cd"
      ],
      "store_id": "86e05affc7a7abecd513ab400",
      "last_login": "2021-04-16 18:22:35.052987"
    }
  }
}