Authenticate User with SAML Authentication

{ authenticateUserSAML }

Generates a Pyramid access authentication token using SAML authentication tokens

Method

/API2/auth/authenticateUserSAML

  • 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

    token

    Type

    string

    Description

    The SAML assertion 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 embedded in every API call to ensure the API calls are authorized. If saved as a cookie in a web browser, it can be used (for the authenticated user) to auto-login into the application. The assumption is that the user has already authenticated via SAML (and has the authentication response) before attempting to authenticate into Pyramid.