Expand All Collapse All

/icws/{sessionId}/connection/unique-auth-token

POST

/icws/{sessionId}/connection/unique-auth-token

Creates a temporary, unique auth token from an existing session. This auth token may be used as a parameter to create a new session with the POST method at /icws/connection and using the authTokenConnectionRequestSettings. This auth token may be used to create a new session only once. The auth token expires within seven seconds after creation.
Feature Version
connection 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.

        Representations
        createUniqueAuthTokenRequest
        Expand AllCollapse All
        Property
        Value
        Comments
        authTokenSeed
        Guid

        Required

        This seed will be used in the generation of the auth token. It should be generated by the caller. The seed is encoded as a part of the returned auth token.

        Response

        200 - OK
        The request was successful. The new auth token is returned in the body of the response.
        createUniqueAuthTokenResponse
        Expand AllCollapse All
        Property
        Value
        Comments
        authToken
        String

        Required

        This is the new, temporary auth token that may be used to create a new session.
        400 - Bad Request
        The request could not be understood by the server due to malformed syntax. The client should not repeat the request without modifications. The auth token was likely not formatted correctly.
        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.
        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.
          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.