openapi: 3.2.0
info:
  title: Acoustic Login service API
  version: 1.0.142
  x-ibm-name: ibm-watson-content-hub-api
  description: 'Operations tagged Login service across 2 of this provider''s published API definitions: acoustic-content-openapi-original.json, acoustic-content-swagger2-original.yaml. Each path carries the servers of the definition it was published in.'
tags:
- name: Login service
  description: Login service offers endpoint to login into Acoustic Content.
paths:
  /login/v1/removecookies:
    get:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
      - authenticatedVisitor
      - anonymous
      summary: Remove tenant and auth cookie.
      description: 'Endpoint to receive a set-cookie cleaning the authentication and tenant cookies for the actual domain.<br />User roles: admin, manager, editor, viewer, authenticatedVisitor, anonymous'
      responses:
        '200':
          description: Cleaning the cookies
          headers:
            set-cookie:
              description: Sending cookies to client
              schema:
                type: string
            set-cookie2:
              description: Sending cookies to client
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  service:
                    type: string
                    description: The service name
                  requestId:
                    type: string
                    description: The current requestId
                  httpStatus:
                    type: integer
                    description: The http return code
        '429':
          description: Too Many Requests, the server has reached a limit, the request must be sent again at a later time.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Login service
  /login/v1/basicauth:
    get:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
      - authenticatedVisitor
      - anonymous
      summary: Userid and password login using GET operation
      description: 'Performs basic authentication using Acoustic ID credentials. The API responds with authentication token (set in the cookie) and tenant information in the response header x-ibm-dx-tenant-id/x-cms-tenant-id. If no tenant for the user is found, the authentication fails presenting a HTTP404 error.

        You can also use API key generated by MyAcoustic page, in which case username is AcousticAPIKey while generating the Base64 encoded Authorization header.<br />User roles: admin, manager, editor, viewer, authenticatedVisitor, anonymous'
      parameters:
      - name: Authorization
        in: header
        description: Login credentials as basicAuthentication header
        required: true
        schema:
          type: string
      - name: accept-privacy-notice
        in: query
        description: (Optional) To accept the latest privacy notice.
        schema:
          type: string
          default: empty
      responses:
        '200':
          description: Success for login.
          headers:
            x-ibm-dx-tenant-id:
              description: Sending tenant-id to client
              schema:
                type: string
            x-ibm-dx-tenant-locale:
              description: Sending tenant-locale to client
              schema:
                type: string
            x-ibm-dx-tenant-base-url:
              description: Sending tenant-base-url to client
              schema:
                type: string
            set-cookie:
              description: Sending cookies to client
              schema:
                type: string
            set-cookie2:
              description: Sending cookies to client
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    baseUrl:
                      type: string
                      description: The baseUrl to call the services
                    tenantId:
                      type: string
                      description: The tenantId of the available tenant
                  description: Object containing the tenantId and baseUrl
                minItems: 0
                maxItems: 100
                description: The list of available tenants for the authenticated user
        '401':
          description: Authentication failed with credentials (incorrect or missing)
          content:
            application/json:
              schema:
                type: object
                properties:
                  service:
                    type: string
                    description: The service name
                  requestId:
                    type: string
                    description: The current requestId
                  httpStatus:
                    type: integer
                    description: The http return code
        '403':
          description: Access forbidden (e.g. no access to tenant or enterprise federation)
          content:
            application/json:
              schema:
                type: object
                properties:
                  service:
                    type: string
                    description: The service name
                  requestId:
                    type: string
                    description: The current requestId
                  httpStatus:
                    type: integer
                    description: The http return code
        '404':
          description: Tenant not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  service:
                    type: string
                    description: The service name
                  requestId:
                    type: string
                    description: The current requestId
                  httpStatus:
                    type: integer
                    description: The http return code
        '412':
          description: Precondition Failed for credentials (incorrect format or missing)
          content:
            application/json:
              schema:
                type: object
                properties:
                  service:
                    type: string
                    description: The service name
                  requestId:
                    type: string
                    description: The current requestId
                  httpStatus:
                    type: integer
                    description: The http return code
        '423':
          description: The tenant is locked
          content:
            application/json:
              schema:
                type: object
                properties:
                  service:
                    type: string
                    description: The service name
                  requestId:
                    type: string
                    description: The current requestId
                  httpStatus:
                    type: integer
                    description: The http return code
        '429':
          description: Too Many Requests, the server has reached a limit, the request must be sent again at a later time.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Downstream service not available (e.g. Acoustic ID)
          content:
            application/json:
              schema:
                type: object
                properties:
                  service:
                    type: string
                    description: The service name
                  requestId:
                    type: string
                    description: The current requestId
                  httpStatus:
                    type: integer
                    description: The http return code
      tags:
      - Login service
    post:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
      - authenticatedVisitor
      - anonymous
      summary: Userid and password login using POST operation
      description: 'Performs basic authentication using Acoustic ID credentials. The API responds with authentication token (set in the cookie) and tenant information in the response header x-ibm-dx-tenant-id/x-cms-tenant-id. If no tenant for the user is found, the authentication fails presenting a HTTP404 error.

        You can also use API key generated by MyAcoustic page, in which case username is AcousticAPIKey while generating the Base64 encoded Authorization header.<br />User roles: admin, manager, editor, viewer, authenticatedVisitor, anonymous'
      parameters:
      - name: Authorization
        in: header
        description: Login credentials as basicAuthentication header
        required: false
        schema:
          type: string
      - name: accept-privacy-notice
        in: query
        description: (Optional) To accept the latest privacy notice.
        schema:
          type: string
          default: empty
      responses:
        '200':
          description: Success for login.
          headers:
            x-ibm-dx-tenant-id:
              description: Sending tenant-id to client
              schema:
                type: string
            x-ibm-dx-tenant-locale:
              description: Sending tenant-locale to client
              schema:
                type: string
            x-ibm-dx-tenant-base-url:
              description: Sending tenant-base-url to client
              schema:
                type: string
            set-cookie:
              description: Sending cookies to client
              schema:
                type: string
            set-cookie2:
              description: Sending cookies to client
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    baseUrl:
                      type: string
                      description: The baseUrl to call the services
                    tenantId:
                      type: string
                      description: The tenantId of the available tenant
                  description: Object containing the tenantId and baseUrl
                minItems: 0
                maxItems: 100
                description: The list of available tenants for the authenticated user
        '401':
          description: Authentication failed with credentials (incorrect or missing)
          content:
            application/json:
              schema:
                type: object
                properties:
                  service:
                    type: string
                    description: The service name
                  requestId:
                    type: string
                    description: The current requestId
                  httpStatus:
                    type: integer
                    description: The http return code
        '403':
          description: Access forbidden (e.g. no access to tenant or enterprise federation)
          content:
            application/json:
              schema:
                type: object
                properties:
                  service:
                    type: string
                    description: The service name
                  requestId:
                    type: string
                    description: The current requestId
                  httpStatus:
                    type: integer
                    description: The http return code
        '404':
          description: Tenant not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  service:
                    type: string
                    description: The service name
                  requestId:
                    type: string
                    description: The current requestId
                  httpStatus:
                    type: integer
                    description: The http return code
        '412':
          description: Precondition Failed for credentials (incorrect format or missing)
          content:
            application/json:
              schema:
                type: object
                properties:
                  service:
                    type: string
                    description: The service name
                  requestId:
                    type: string
                    description: The current requestId
                  httpStatus:
                    type: integer
                    description: The http return code
        '423':
          description: The tenant is locked
          content:
            application/json:
              schema:
                type: object
                properties:
                  service:
                    type: string
                    description: The service name
                  requestId:
                    type: string
                    description: The current requestId
                  httpStatus:
                    type: integer
                    description: The http return code
        '429':
          description: Too Many Requests, the server has reached a limit, the request must be sent again at a later time.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Downstream service not available (e.g. Acoustic ID)
          content:
            application/json:
              schema:
                type: object
                properties:
                  service:
                    type: string
                    description: The service name
                  requestId:
                    type: string
                    description: The current requestId
                  httpStatus:
                    type: integer
                    description: The http return code
      tags:
      - Login service
components:
  schemas:
    ErrorResponse:
      description: This JSON record represents an error condition.
      type: object
      properties:
        errors:
          type: array
          items:
            description: This JSON record represents an individual error or warning contained in an error message.
            type: object
            properties:
              code:
                type: integer
                description: An error code
              message:
                type: string
                description: A message describing what went wrong.
              description:
                type: string
                description: Further explanation of the error condition and potential next steps to resolve the problem.
              more_info:
                type: string
                description: A URL pointing to a web site that provides more information on the given error condition.
              level:
                type: string
                enum:
                - ERROR
                - WARNING
                description: The severity level of the message. Default is error.
              parameters:
                type: object
                description: Additional properties reflecting the dynamic parts of the error condition.
              cause:
                type: object
                description: This property can be used to transport causing error message records produced by a down stream service calls.
              locale:
                type: string
                description: This property represents the locale of the text contained in properties 'message', and 'description'. This property is mandatory if message and description contain translated text.
            required:
            - code
            - message
        requestId:
          type: string
          description: The ID of the failing request.
        service:
          type: string
          description: The name of the service serving the error message.
      required:
      - errors
      - requestId
x-refined-from:
- acoustic-content-openapi-original.json
- acoustic-content-swagger2-original.yaml
x-readme:
  explorer-enabled: true
  proxy-enabled: true