Authenticate User for Embedding with SAML Authentication

{ authenticateUserEmbedSAML }

Generates a Pyramid access authentication token for embedding using SAML authentication tokens

Method

/API2/auth/authenticateUserEmbedSAML

  • API Section: /API2/auth
  • API Version: 2.0
  • From Release: 2020.17
  • Can be used by Non-admin accounts
  • Method operates via POST actions only.
    • Input Parameters

    Name

    userSamlCredentials

    Object Type

    UserSamlCredentials

    Description

    The user credentials for authentication by SAML token.

    Output Response

    Successful Result Code

    200

    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 SAML in the hosting application (and has the authentication response) before attempting to authenticate into Pyramid.