---
swagger: "2.0"
info:
  x-ibm-name: InitiateKafkaSessionLogin
  title: InitiateKafkaSessionLogin
  version: 1.0.0
  description: APIConnect require to log some message to Kafka, such as error 429
    from Datapower, Limit Exceed and so on.
schemes:
- https
tags: []
basePath: /api
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  clientIdHeader:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
security: []
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /private/v1/kafka/sessions/login:
    post:
      summary: APIConnect require to log some message to Kafka, such as error 429
        from Datapower, Limit Exceed and so on.
      description: APIConnect require to log some message to Kafka, such as error
        429 from Datapower, Limit Exceed and so on.
      tags:
      - Regulatory
      operationId: InitiateKafkaSessionLogin
      parameters:
      - name: client_id
        in: header
        description: Client ID generated during application registration with the
          internal development portal. The internal API Gateway will authenticate
          the application using the client_id and client_secret. Required if accessing
          APIs via the internal API Gateway.
        type: string
        required: false
      - name: client_secret
        in: header
        description: Client Secret generated during application registration with
          the internal development portal. The internal API Gateway will authenticate
          the application using the client_id and client_secret. Required if accessing
          APIs via the internal API Gateway.
        type: string
        required: false
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response. Always pass
          application/json.
        type: string
        required: true
      - name: Accept-Language
        in: header
        description: List of acceptable human languages for response.
        type: string
        required: false
      - name: Content-Type
        in: header
        description: The MIME type of the body of the request (used with POST and
          PUT requests). Always pass application/json.
        type: string
        required: false
      - name: uuid
        in: header
        description: 128 bit random universally unique identifier (UUID) generated
          for every request.
        type: string
        required: true
      - name: sid
        in: header
        description: Session ID.
        type: string
        required: false
      - name: channelId
        in: header
        description: 'Registered channel ID for the consumer. Examples: HBK(CBOL),
          ECL(Eclipse), MBK(Mobile Banking).'
        type: string
        required: true
      - name: businessCode
        in: header
        description: 'Citi business codes. Examples: GCB, VMA, QCC.'
        type: string
        required: true
      - name: countryCode
        in: header
        description: 'Country code in ISO 3166 alpha-2 format. Examples: SG(Singapore),
          PH(Philippines), TH(Thailand).'
        type: string
        required: true
      - name: i-cif
        in: header
        description: Unique customer number generated by RM and used in other host
          systems.
        type: string
        required: false
      - name: x-userID
        in: header
        description: SOE ID of the user sending the request. Applicable only for assisted
          channels like Eclipse.
        type: string
        required: false
      - name: x-userDomicileBranchCode
        in: header
        description: Domicile branch code of the user sending the request. Applicable
          only for assisted channels like Eclipse.
        type: string
        required: false
      - name: x-userDomicileResponsibilityCentre
        in: header
        description: Responsibility centre of the user sending the request. Applicable
          only for assisted channels like Eclipse.
        type: string
        required: false
      - name: x-processingBranchCode
        in: header
        description: Branch code where the request is processed. Applicable only for
          assisted channels like Eclipse.
        type: string
        required: false
      - name: x-processingResponsibilityCentre
        in: header
        description: Responsibility centre of the branch where the request is processed.
          Applicable only for assisted channels like Eclipse.
        type: string
        required: false
      - name: x-userGroup
        in: header
        description: 'User group. Applicable only for assisted channels like Eclipse.
          Examples: CPC(CitiPhone), PWS(Branch), BKO (BackOffice), PWT (Teller), MSF(Mobile
          Sales Force).'
        type: string
        required: false
      - name: x-sessionLanguageCode
        in: header
        description: 'Session language code in ISO 639-1 format. Applicable only for
          assisted channels like Eclipse. Examples: EN(English), PL(Polish), RU(Russian),
          ES(Spanish).'
        type: string
        required: false
      - name: i-ccsid
        in: header
        description: Customer Credential Store (CCS) unique ID for userID/password.
          Can be used to uniquely identify a customer in CCS.
        type: string
        required: false
      - name: consumerOrgCode
        in: header
        description: Unique code to identify the consumer organization
        type: string
        required: false
      - name: clientDetails
        in: header
        description: Information on the client / device / terminal firing the request.
          Information includes device ID, device name, client IP address, terminal
          ID, etc.
        type: string
        required: false
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/InitiateKafkaSessionLoginResponse'
        400:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>invalid</td><td>invalidRequest</td><td>Missing
            or invalid Parameters</td></tr><tr><td>error</td><td>invalidMemberAccessToken</td><td>Member
            access token is invalid.</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        401:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>unAuthorized</td><td>Authorization
            credentials are missing or invalid</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        403:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>accessNotConfigured</td><td>The
            request operation is not configured to access this resource</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        404:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>resourceNotFound</td><td>Empty
            resource/resource not found</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        422:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>error</td><td>businessValidationsFailed</td><td>Business
            validations failed</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
        500:
          description: <table><tr><td>Type</td><td>Code</td><td>Details</td></tr><tr><td>fatal</td><td>serverUnavailable</td><td>The
            request failed due to an internal error</td></tr></table>
          schema:
            $ref: '#/definitions/ErrorResponse'
definitions:
  InitiateKafkaSessionLoginResponse:
    properties:
      messageId:
        description: Message ID for the service request
        type: string
        example: "123456789"
      eventProducer:
        description: Producer of Event
        type: string
        example: Datapower
      transactionStatus:
        description: 'This is the status of Transactio. '
        type: string
        example: Failure
      responseStatusCode:
        description: status code of response
        type: string
        example: "429"
      responseStatusMessage:
        type: string
        description: status message of response
        example: Limit Exceeded
      businessFunctionId:
        description: businessFunctionId
        type: string
        example: Datapower
      requestUrl:
        description: requestUrl
        type: string
        example: /api/operation
      correlationId:
        description: correlationId
        type: string
        example: "987654321"
      alternateSessionId:
        type: string
        description: alternateSessionId
        example: 123456sdgfgi
      businessId:
        type: string
        description: businessId
        example: GCB
      clientIpAddress:
        description: clientIpAddress
        type: string
        example: 172.23.62.36
      jsonPayloadMethod:
        description: jsonPayloadMethod
        type: string
        example: GET
      requestBody:
        description: requestBody
        type: string
        example: https://localhost:8080/api/operation
      responseBody:
        type: string
        description: responseBody
        example: Limit Exceeded
      tppIdentifier:
        type: string
        description: TPPIdentifier
        example: Datapower
      startTime:
        type: string
        format: time
        description: A JSON number representing the number of millisecond from 1970-01-01T00:00:00Z
          to the UTC expiry time.
        example: "1610652577398"
      providerInfo:
        type: array
        items:
          $ref: '#/definitions/ProviderInfo'
    required:
    - messageId
  ErrorResponse:
    properties:
      type:
        description: Invalid - Request did not confirm to the specification and was
          unprocessed and rejected. Please fix the value and try again
        enum:
        - error
        - warn
        - invalid
        - fatal
        type: string
      code:
        description: Error code which qualifies the error
        type: string
      details:
        description: Human readable explanation specific to the occurrence of the
          problem
        type: string
      location:
        description: The name of the field that resulted in the error
        type: string
      moreInfo:
        description: URI to human readable documentation of the error
        type: object
    required:
    - type
    - code
  ProviderInfo:
    properties:
      code:
        description: Codes for overridable host errors, warning messages, or additional
          info.
        type: string
      detail:
        description: Description for the host error, warning, or additional info
        type: string
      fieldId:
        description: The field which generated the host error, warning, or additional
          info
        type: string
    required:
    - code
    - detail
x-ibm-endpoints:
- endpointUrl: https://aspac.sandbox.api.citi.com/gcbap
  description: Custom Gateway API Endpoint
  type:
  - production
  - development
...