API Reference

User SSO login

post
https://{project_url}/webservice/rest-api/{api_interface}/{version}/users/actions/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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

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

string
required

Single sign-on token from CareCloud.

Headers
string
Defaults to cs, en-gb;q=0.8

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

Responses

error.error_data.invalid_params[] array lists the parameters that caused the failure, each carrying a reason code. See the BadRequestErrorBody schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated 3 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago