Expand All Collapse All

/icws/connection/server-info

GET

/icws/connection/server-info

Queries for information on the server.
Feature Version
connection 1

Request

Parameters
Type
Name
Comments
Query
singleSignOnCapabilities

A comma delimited list of client capabilities for single sign-on. The server will make a decision on how to contact the identity provider through the client. The currently supported options are:

  • saml2Post - SAML 2.0 HTTP POST capability. Recommended for web browser-based applications.
  • saml2Redirect - SAML 2.0 HTTP redirect capability. Recommended for other types of applications.
  • saml2ECP - SAML 2.0 Enhanced Client or Proxy capability. Recommended for smart client applications.

Example: singleSignOnCapabilities=saml2Redirect,saml2Post

Feature Version
connection 3

    Query
    displayLanguage

    The displayLanguage parameter is an IETF language tag (e.g. en-US) used by the server to determine the language to use for the display strings in the response. This parameter differs from the Accept-Language header in that setting this will only affect the language of the userAgreementText and the display names of the identityProviders properties of the response's authentication property.

    Feature Version
    connection 6

      Header
      Accept-Language

      The Accept-Language parameter is used by the server to determine the primary language of the client. This header determines the language for any human-readable text, as well as formats for time, dates, and money.

      Feature Version
      connection 2

        Response

        200 - OK
        The server information was successfully retrieved and is available in the entity body.
        serverInfo
        Expand AllCollapse All
        Property
        Value
        Comments
        languageID
        String

        Required

        The language's ID string. This is identical to the language's ISO 639 language code.
        languageDisplayName
        String

        Required

        The language's localized display name string.
        acceptLanguage
        String

        Required

        The contents of the request's accept-language header as a convenience for browser-based applications.
        allowIcAuth
        Boolean

        Required

        Denotes whether IC authententication credentials will be accepted by the server.
        displayName
        String

        Required

        The identity provider's localized display name string.
        identityProviderId
        String

        Required

        The identity provider's unique identifier.
        builtInIdentityProvider
        Boolean

        Required

        Indicates whether the identity provider is one of the built-in identity providers.
        Feature Version
        connection 8
        userAgreementText
        String

        The language-specific user agreement text to be presented to the user before they connect to the IC Server. The user should accept the agreement before the client connects to the IC Server. ICWS does not have any mechanism for enforcing this behavior. This property will not be present if there is no configured user agreement.

        Feature Version
        connection 6
        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
        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.
        500 - Internal Server Error
        An unexpected error occurred while processing the request.
        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.