Authenticate User for Embedding with OpenID Authentication

{ authenticateUserEmbedOPENID }

Generates a Pyramid access authentication token for embedding using OpenID parameter map

Method

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

    Name

    userOpenIdCredentials

    Object Type

    Description

    The user credentials for authentication by OpenID parameter map.

    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. The assumption is that the user has already authenticated via OPENID in the hosting application before attempting to authenticate into Pyramid.

    Examples