---
swagger: "2.0"
info:
  description: This will provide key-related functionalities. </br>ECS Deploy Ref
    (GC) --> FDN-D-Cryptography-SEG-DGL-EA ;</br>ECS Deploy Ref (EMEA) --> FDN-D-Cryptography-SEG-DGL-EA-EM
  version: 1.0.0
  x-ibm-name: Foundations_Cryptography_SecurityGateway_Digital_Domain_OpenAPI
  title: Foundations_Cryptography_SecurityGateway_Digital_Domain_OpenAPI
host: 127.0.0.1
schemes:
- https
basePath: /openapi/foundations/cryptography/securityGateway/v1
produces:
- application/json
paths:
  /thales/{serviceName}:
    get:
      summary: This will provide key-related functionalities.
      description: This will provide key-related functionalities where client will
        provide some information.
      operationId: SetupSecurityGateway
      tags:
      - Foundations_Utilities_Cryptography
      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.
        required: true
        type: string
      - name: Authorization
        in: header
        description: 'The most recent Authorization token. This will have the format
          Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.'
        type: string
        required: true
      - name: Accept
        in: header
        description: Content-Types that are acceptable for the response. Always pass
          application/json.
        type: string
        required: false
      - 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: false
      - 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: This field is used to capture device,browser and network information.
          Refer the developer portal for more information.These are the fields which
          will be passed as part of the header devicePrint,deviceTokenCookie,userIpAddress,userAgent,hardwareId,simId,deviceModel,deviceName,deviceOsName,deviceOsVersion,multitaskingSupportFlag,languageSupport,wifiMacAddress,cellTowerId,locationAreaCode,rsaApplicationKey,wapClientId,mobileCarrierCode,mobileCountryCode,osId,geoLongitude,geoLatitude,geoHorizontalAccuracy,geoAltitude,geoAltitudeAccuracy,geoSpeed,geoTimestamp,geoStatus,basicServiceSetId,signalStrength,wifiChannel,serviceSetId
        type: string
        required: false
      - name: serviceName
        in: path
        description: Service which channel will invoke like APINUpdate, CVVVerification
          and more
        type: string
        required: true
      - name: operationName
        in: query
        description: Operation which involve the cryptographics operation under a
          service such as encrypt, decrypt, translate more
        type: string
        required: true
      responses:
        200:
          description: Successful operation.
          schema:
            $ref: '#/definitions/SetupSecurityGatewayResponse'
        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></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>Access
            is not configured for 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>accessNotConfigured</td><td>Access
            is not configured for this resource</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:
  SetupSecurityGatewayResponse:
    properties:
      key:
        description: This is key for key-value map that contains the response payload
          fields
        type: string
        example: keyGenerationId
      value:
        description: This is value for key-value map that contains the response payload
          fields
        type: string
        example: 1
      providerInfo:
        type: array
        items:
          $ref: '#/definitions/ProviderInfo'
    required:
    - key
    - value
  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 ICR step which generated the host error, warning, or additional
          info.
        type: string
    required:
    - code
    - detail
  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
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
x-ibm-endpoints:
- endpointUrl: https://aspac.sit.api.citi.com/gcbap
  description: ""
  type:
  - production
  - development
...