/icws/{sessionId}/configuration/single-sign-on-identity-providers

GET

/icws/{sessionId}/configuration/single-sign-on-identity-providers

Retrieves a list of singleSignOnIdentityProviders. The results can be filtered by specifying a query. All list-based configuration object resources will have a complex property that will serve as its identity. This property is called the configurationId and consists of a {id, displayName, uri}.

The following result limits are enforced by the server regardless of the value of the Range header field:

  • If no properties are included (see select parameter), then all of the items will be returned.
  • If any properties are included (see select parameter), then a maximum of 200 items will be returned in the result.
Feature Version
configuration 1

Request

Parameters
Type
Name
Comments
Header
ININ-ICWS-CSRF-Token

Required

The ININ session token necessary for all calls that require a security or user context.

    Header
    Cookie

    Required

    The session cookie. With the exception of the connection request, all requests must provide a session cookie.

      Template
      sessionId

      Required

      The ININ session ID necessary for all calls that require a security or user context.

        Header
        Range

        Specifies the range of results to be returned.

        Example: Range: items=10-20.

          Query
          select

          A comma-delimited list of fields to include in the query. If no fields are specified, then only the ID of the items is returned.

          Example: select=extension,defaultWorkstation

          One can also specify that all of the properties should be returned by using the '*' wildcard value. This is a shortcut for specifying all of the properties' names in the parameter.

          The selected properties with a NULL value will not be returned to conserve the Interaction Center server's resources.

            Query
            where

            A comma-delimited list of conditions to filter the results of the query. Only items that satisfy all conditions will be returned.

            The following operators can be used:

            • eq - equals
            • sw - starts with
            • ct - contains

            Example: where=configurationId.id sw Value

            It is supported for the following properties:

            • configurationId.displayName
            • configurationId.id
            • notes

              Query
              orderBy

              The name of the field to sort the results by and an optional sort direction. The default is to sort by configurationId.displayName in ascending order. A query can only be sorted by one field and only supports one (optional) direction indicator: asc (ascending) or desc (descending).

              To sort in descending order use: orderBy=configurationId.id desc

              To sort in ascending order use: orderBy=configurationId.id (or orderBy=configurationId.id asc)

              It is supported for the following properties:

              • configurationId.displayName
              • configurationId.id

              Default value: configurationId.displayName

                Query
                rightsFilter
                The security right to use when filtering the results.

                Default value: admin

                Options:

                • view
                • admin

                Response

                200 - OK
                The result set of the query is included in the response.
                Parameters
                Type
                Name
                Comments
                Header
                Content-Range

                Required

                Specifies the range of items being returned in the result along with the total number of items.

                Example: Content-Range: items 5-10/200

                  singleSignOnIdentityProviders
                  Represents a list of singleSignOnIdentityProvider configuration objects.
                  Property
                  Value
                  Comments
                  id
                  String

                  Required

                  The unique identifier used to reference this configuration object.
                  displayName
                  String
                  The display name of this configuration object.

                  This property can be null.

                  uri
                  Uri
                  A URI used to access this configuration object.
                  createdDate
                  DateTime
                  The date this configuration object was created.

                  This is a read only property and can not be changed with PUT or POST operations.

                  This property can be null.

                  name
                  String

                  Required

                  The key identifying this pair.
                  value
                  String

                  Required

                  The value of this pair.

                  This property can be null.

                  lastModifiedDate
                  DateTime
                  The date this configuration object was last modified.

                  This is a read only property and can not be changed with PUT or POST operations.

                  This property can be null.

                  notes
                  String
                  The notes for this configuration object.

                  This property can be null.

                  400 - Bad Request
                  Invalid parameter value was specified.

                  Error Responses

                  Error Identifier
                  Error Type
                  Error Description
                  error.request.invalidRepresentation.malformed
                  Type: urn:inin.com:common:error
                  The request representation object was malformed.
                  Feature Version
                  configuration 2
                  error.request.configuration.get.selectAll
                  Type: urn:inin.com:common:error
                  Combining the wildcard (*) and one or more specific properties in one request is not supported.
                  Feature Version
                  configuration 2
                  error.request.configuration.getObjectList
                  Type: urn:inin.com:configuration:getObjectListError
                  One or more of the properties in the 'rightsFilter', 'select', 'where', or 'orderBy' query parameters are not supported.
                  Feature Version
                  configuration 2
                  error.request.configuration.getObjectList.invalidSortDirection
                  Type: urn:inin.com:common:error
                  The sort direction in the 'orderBy' query parameter is not supported.
                  Feature Version
                  configuration 2
                  error.request.configuration.getObjectList.invalidWhereOperator
                  Type: urn:inin.com:common:error
                  The operator in the 'where' query parameter is not supported.
                  Feature Version
                  configuration 2
                  error
                  Provides additional detail for an error.
                  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:configuration:getObjectListError"

                  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.
                  select
                  List [Unbounded]: String
                  The properties in the select query parameter that are not supported by the object type.

                  Property type documentation:

                  Represents a collection of strings.

                  rightsFilter
                  String
                  The properties in the rightsFilter query parameter that are not supported by the object type.
                  where
                  List [Unbounded]: String
                  The properties in the where query parameter that are not supported by the object type.

                  Property type documentation:

                  Represents a collection of strings.

                  orderBy
                  String
                  The property in the orderBy query parameter is not supported by the object type.
                  500 - Internal Server Error
                  An unexpected error occurred while processing the request.

                  Error Responses

                  Error Identifier
                  Error Type
                  Error Description
                  error.request.internalServerError
                  Type: urn:inin.com:common:error
                  The server encountered an unexpected, internal error.
                  Feature Version
                  configuration 2
                  error.request.timeout
                  Type: urn:inin.com:common:error
                  The request timed out.
                  Feature Version
                  configuration 2
                  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.
                  401 - Unauthorized
                  The specified session token is missing, invalid, or has expired.
                  Parameters
                  Type
                  Name
                  Comments
                  Header
                  WWW-Authenticate

                  Required

                  Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.

                  WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"

                    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.
                    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.