/icws/{sessionId}/configuration/certificates/trust-subsystem-certificate

PUT

/icws/{sessionId}/configuration/certificates/trust-subsystem-certificate

Trusts (or untrusts) a subsystem certificate on the IC Server.
Feature Version
configuration 11

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.

        Representations
        trustSubsystemCertificateArgument
        Represents an argument for trustSubsystemCertificate.
        Property
        Value
        Comments
        name
        String

        Required

        The unique name of the certificate to trust or untrust.

        The value of this property can be obtained from subsystemCertificateEntry's name property using GET /icws/{sessionId}/configuration/certificates/subsystem-certificates.

        trust
        Boolean

        Required

        Sets whether to trust or untrust the specified certificate. Must be one of the following values:

        true
        Trust the specified certificate.
        false
        Untrust the specified certificate.

        Warning

        Once a certificate is untrusted, subsystems using the certificate will not be allowed to connect to the IC Server.

        Response

        204 - No Content
        The certificate was trusted (or untrusted) successfully.
        400 - Bad Request
        Invalid request was provided.

        Error Responses

        Error Identifier
        Error Type
        Error Description
        error.request.invalidRepresentation.missingRequired
        Type: urn:inin.com:common:missingPropertyError
        The request representation object was missing a required property.
        error.request.invalidRepresentation.malformed
        Type: urn:inin.com:common:error
        The request representation object was malformed.
        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: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.
        403 - Forbidden
        Not authorized to create these resources.
        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.
        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.
        error.request.timeout
        Type: urn:inin.com:common:error
        The request timed out.
        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.