Expand All Collapse All

/icws/connection/single-sign-on/return

Feature Version
connection 3

GET

/icws/connection/single-sign-on/return

Returns the response from the identity provider through the client as an HTTP redirect to the server. Applications running in a web browser should not handle the responses directly and allow the web browser to perform the necessary steps. Other applications should refer to the HTTP status codes and headers and react appropriately while ignoring the response body.
Feature Version
connection 3

Request

The SAML response message base64 encoded into the request URL as specified by the SAML 2.0 HTTP Redirect Binding. This request has no parameters.

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 used for authentication with the server.

This response is generated when the returnUri query string parameter was omitted from the request to GET /icws/connection/single-sign-on/identity-providers/{identityProviderId}.

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
    302 - Found

    The server has successfully accepted the response from the identity provider. The server is redirecting back to the application based on the information originally provided. The application now should retrieve the single sign-on token from the server by requesting GET /icws/connection/single-sign-on/response.

    This response is generated when the returnUri query string parameter was included with the request to GET /icws/connection/single-sign-on/identity-providers/{identityProviderId}. The Location response header is the same as the returnUri value.

    Feature Version
    connection 5
    Parameters
    Type
    Name
    Comments
    Header
    Set-Cookie

    Required

    The single sign-on response cookie. This cookie is consumed by browsers automatically. Non-browser client applications may need to manually extract this cookie and pass it as the header parameter Cookie in the subsequent call to GET /icws/connection/single-sign-on/response.

    Example: Set-Cookie: icws_sso_response={value}; HttpOnly; Path=/icws/connection/single-sign-on/response

      Header
      Location

      Required

      Specifies the URI that was provided in the redirectUri query string parameter by the client when the request GET /icws/connection/single-sign-on/identity-providers/{identityProviderId} was made. The client now should now redirect to this location to complete the single sign-on process.

        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.
        Expand AllCollapse All
        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/return

        Returns the response from the identity provider through the client as an HTML form to the server. Applications running in a web browser should not handle the responses directly and allow the web browser to perform the necessary steps. Other applications should refer to the HTTP status codes and headers and react appropriately while ignoring the response body.
        Feature Version
        connection 3

        Request

        The SAML response message base64 encoded as a HTML form POST as specified by the SAML 2.0 HTTP POST Binding. This request has no parameters.

        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
          302 - Found
          The server has successfully accepted the response from the identity provider. The server is redirecting back to the application based on the information originally provided. The application now should retrieve the single sign-on token from the server by requesting GET /icws/connection/single-sign-on/response.
          Feature Version
          connection 5
          Parameters
          Type
          Name
          Comments
          Header
          Set-Cookie

          Required

          The single sign-on response cookie. This cookie is consumed by browsers automatically. Non-browser client applications may need to manually extract this cookie and pass it as the header parameter Cookie in the subsequent call to GET /icws/connection/single-sign-on/response.

          Example: Set-Cookie: icws_sso_response={value}; HttpOnly; Path=/icws/connection/single-sign-on/response

            Header
            Location

            Required

            Specifies the URI that was provided in the redirectUri query string parameter by the client when the request GET /icws/connection/single-sign-on/identity-providers/{identityProviderId} was made. The client now should now redirect to this location to complete the single sign-on process.

              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.
              Expand AllCollapse All
              Property
              Value
              Comments
              errorId
              String
              The error identifier that describes the current error.
              message
              String

              Required

              A message that describes the current error.