Authenticate User for Embedding

{ authenticateUserEmbed }

Generates an access authentication token for the given user to use the embedded content functionality.

Method

/API2/auth/authenticateUserEmbed
  • API Section: /API2/auth
  • API Version: 2.0
  • From Release: 2018.5
  • Can be used by all user types
  • REST API only via POST actions.
  • Input Parameters

    Name

    userCredentials

    Object Type

    Description

    The user credential object used to set a user's login settings.

    Output Response

    Successful Result Code

    200

    Response Type

    string

    Description of Response Type

    The response is the security token as a base64 string. It is usually stored in a cookie.

    Notes

    The security token is a string that needs to be added to a cookie on the third party host page for any embedded content to ensure the access is authorized.

    Examples