/icws/connection/single-sign-on/saml-ecp/{identityProviderId}

Feature Version
connection 7

GET

/icws/connection/single-sign-on/saml-ecp/{identityProviderId}

Starts the single sign-on process with the server, using the SAML ECP profile. Applications should forward the responses to the specified identity provider using the SAML SOAP binding.
Feature Version
connection 7

Request

Parameters
Type
Name
Comments
Template
identityProviderId

Required

An identifier specifying the identity provider.

    Header
    ININ-ICWS-Original-URL

    Specifies the URL that the client is using to request resources from the server through a proxy that is rewriting URLs to reach the server.

    Ideally, the client should not set this value. Instead, the proxy should set it with its authority if it is not specified by a previous proxy.

    Example: ININ-ICWS-Original-URL: https://proxy/api/server/icws/connection/version/

      Response

      200 - OK
      The server has sent, using the SAML Reverse SOAP binding, information that must be sent to the identity provider. That information should be sent to the specified identity provider using the SAML SOAP binding.
      Content-Type: text/xml
      400 - Bad Request
      The request was invalid. This can occur when the message body is malformed or missing required items. This will also occur if a required header or query string parameter is missing or invalid.
      Content-Type: text/html
      404 - Not Found
      The specified identity provider does not exist.
      Content-Type: text/html
      500 - Internal Server Error
      An unexpected error occurred while processing the request.
      Content-Type: text/html
      410 - Gone
      This resource has been deprecated and removed from the API.
      error
      Provides additional detail for an error.
      Property
      Value
      Comments
      errorId
      String
      The error identifier that describes the current error.
      message
      String

      Required

      A message that describes the current error.

      POST

      /icws/connection/single-sign-on/saml-ecp/{identityProviderId}

      This method is used to send the responses from the identity provider to the server, using the SAML Reverse SOAP binding.
      Feature Version
      connection 7

      Request

      The SAML response, as specified by the SAML ECP profile, using the SAML Reverse SOAP binding.
      Parameters
      Type
      Name
      Comments
      Template
      identityProviderId

      Required

      An identifier specifying the identity provider.

        Header
        ININ-ICWS-Original-URL

        Specifies the URL that the client is using to request resources from the server through a proxy that is rewriting URLs to reach the server.

        Ideally, the client should not set this value. Instead, the proxy should set it with its authority if it is not specified by a previous proxy.

        Example: ININ-ICWS-Original-URL: https://proxy/api/server/icws/connection/version/

          Representations
          Content-Type: text/xml

          Response

          200 - OK
          The server has successfully accepted the response from the identity provider. The resulting HTML page and HTTP headers contain a token that may be uses for authentication with the server.
          Parameters
          Type
          Name
          Comments
          Header
          ININ-STS-Token

          An authentication token that may be used to create a connection to the server.

            Content-Type: text/html
            400 - Bad Request
            The request was invalid. This can occur when the message body is malformed or missing required items. This will also occur if a required header or query string parameter is missing or invalid.
            Content-Type: text/html
            500 - Internal Server Error
            An unexpected error occurred while processing the request.
            Content-Type: text/html
            410 - Gone
            This resource has been deprecated and removed from the API.
            error
            Provides additional detail for an error.
            Property
            Value
            Comments
            errorId
            String
            The error identifier that describes the current error.
            message
            String

            Required

            A message that describes the current error.