Expand All Collapse All

/icws/connection/single-sign-on/response

Feature Version
connection 5

GET

/icws/connection/single-sign-on/response

Returns the single sign-on response to the client from the icws_sso_response cookie.
Feature Version
connection 5

Request

Parameters
Type
Name
Comments
Header
Cookie

Required

The single sign-on response cookie.

Example: Cookie: icws_sso_response={value}

    Response

    200 - OK
    The client should use the token provided by the server to connect to the server by requesting POST /icws/connection with a singleSignOnTokenConnectionRequestSettings data contract.
    singleSignOnResponse
    Expand AllCollapse All
    Property
    Value
    Comments
    singleSignOnToken
    String

    Required

    The single sign-on token that can be used to create a connection by requesting POST /icws/connection with a singleSignOnTokenConnectionRequestSettings data contract.
    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.

    Error Responses

    Error Identifier
    Error Type
    Error Description
    error.request.invalidRepresentation.missingRequiredParameter
    Type: urn:inin.com:common:missingPropertyError
    A required parameter was not present.
    error.request.connection.singleSignOn.failure
    Type: urn:inin.com:common:error
    The single sign-on process failed.
    error.sso.authentication
    Type: urn:inin.com:common:error
    The authentication process failed.
    error.sso.authentication.cancelled
    Type: urn:inin.com:common:error
    The user cancelled the authentication process.
    error.sso.request.identityProviderUnavailable
    Type: urn:inin.com:common:error
    The identity provider specified does not exist.
    error
    Provides additional detail for an error.
    Expand AllCollapse All
    Property
    Value
    Comments

    Multiple options:

    The value can be assigned any of the following options.
    errorId
    String
    The error identifier that describes the current error.
    message
    String

    Required

    A message that describes the current error.
    __type
    "urn:inin.com:common:missingPropertyError"

    Required

    The JSON type representing this option.
    errorId
    String
    The error identifier that describes the current error.
    message
    String

    Required

    A message that describes the current error.
    propertyName
    String
    The name of the missing required property.
    500 - Internal Server Error
    The server encountered an unexpected error during the single sign-on process.

    Error Responses

    Error Identifier
    Error Type
    Error Description
    error.sso.server
    Type: urn:inin.com:common:error
    The server encountered an unexpected, internal error.
    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.
    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.