Oracle E-Business Suite Authentication API

openapi: 3.1.0
info:
  title: Oracle EBS e-Commerce Gateway Accounts Payable Authentication API
  description: RESTful APIs for Oracle E-Business Suite e-Commerce Gateway providing EDI (Electronic Data Interchange) transaction support. Enables exchange of standard ASC X12 and EDIFACT documents with trading partners through flat ASCII file integration with third-party EDI translators. Supports inbound and outbound document processing for purchase orders, invoices, ship notices, and other business documents.
  version: 12.2.0
  contact:
    name: Oracle Support
    email: support@oracle.com
    url: https://support.oracle.com
  license:
    name: Oracle Proprietary
    url: https://www.oracle.com/legal/terms/
  x-logo:
    url: https://www.oracle.com/a/ocom/img/oracle-logo.svg
servers:
- url: https://{instance}.oracle.com/webservices/rest
  description: Oracle EBS ISG REST endpoint
  variables:
    instance:
      default: ebs-host
      description: The Oracle EBS instance hostname
tags:
- name: Authentication
  description: Login, session initialization, and logout operations
paths:
  /login:
    get:
      operationId: login
      summary: Authenticate and Obtain Access Token
      description: Authenticates a user using HTTP Basic Authentication and returns a session access token for subsequent REST service calls. The access token is returned both as a cookie and in the response body.
      tags:
      - Authentication
      security:
      - basicAuth: []
      parameters:
      - $ref: '#/components/parameters/AcceptLanguage'
      - $ref: '#/components/parameters/ContentType'
      responses:
        '200':
          description: Successful authentication
          headers:
            Set-Cookie:
              description: Session access token cookie
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginResponse'
              examples:
                Login200Example:
                  summary: Default login 200 response
                  x-microcks-default: true
                  value:
                    response:
                      data:
                        accessToken: example_value
                        accessTokenName: example_value
                        ebsVersion: example_value
                        userName: example_value
            application/xml:
              schema:
                $ref: '#/components/schemas/LoginResponse'
              examples:
                Login200Example:
                  summary: Default login 200 response
                  x-microcks-default: true
                  value:
                    response:
                      data:
                        accessToken: example_value
                        accessTokenName: example_value
                        ebsVersion: example_value
                        userName: example_value
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Login401Example:
                  summary: Default login 401 response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      detail: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /initialize:
    post:
      operationId: initialize
      summary: Initialize Application Context
      description: Initializes the application context including responsibility, security group, and organization for the authenticated session. Must be called after login and before invoking any custom REST services.
      tags:
      - Authentication
      security:
      - tokenAuth: []
      parameters:
      - $ref: '#/components/parameters/AcceptLanguage'
      - $ref: '#/components/parameters/ContentType'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InitializeRequest'
            examples:
              InitializeRequestExample:
                summary: Default initialize request
                x-microcks-default: true
                value:
                  data:
                    resp:
                      id: abc123
                      applId: '500123'
                      key: example_value
                      applKey: example_value
                    securityGroup:
                      id: abc123
                      key: example_value
                    org:
                      id: abc123
                      key: example_value
          application/xml:
            schema:
              $ref: '#/components/schemas/InitializeRequest'
            examples:
              InitializeRequestExample:
                summary: Default initialize request
                x-microcks-default: true
                value:
                  data:
                    resp:
                      id: abc123
                      applId: '500123'
                      key: example_value
                      applKey: example_value
                    securityGroup:
                      id: abc123
                      key: example_value
                    org:
                      id: abc123
                      key: example_value
      responses:
        '200':
          description: Context initialized successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InitializeResponse'
              examples:
                Initialize200Example:
                  summary: Default initialize 200 response
                  x-microcks-default: true
                  value:
                    response:
                      data: example_value
            application/xml:
              schema:
                $ref: '#/components/schemas/InitializeResponse'
              examples:
                Initialize200Example:
                  summary: Default initialize 200 response
                  x-microcks-default: true
                  value:
                    response:
                      data: example_value
        '400':
          description: Invalid initialization parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Initialize400Example:
                  summary: Default initialize 400 response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      detail: example_value
        '401':
          description: Unauthorized - invalid or missing token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Initialize401Example:
                  summary: Default initialize 401 response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      detail: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /logout:
    get:
      operationId: logout
      summary: Terminate Session and Invalidate Token
      description: Logs out the current user and invalidates the session access token. Should be called when the client is finished making REST service calls.
      tags:
      - Authentication
      security:
      - tokenAuth: []
      responses:
        '200':
          description: Successfully logged out
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogoutResponse'
              examples:
                Logout200Example:
                  summary: Default logout 200 response
                  x-microcks-default: true
                  value:
                    response:
                      data: example_value
        '401':
          description: Unauthorized - invalid or expired token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Logout401Example:
                  summary: Default logout 401 response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      detail: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    InitializeResponse:
      type: object
      properties:
        response:
          type: object
          properties:
            data:
              type: string
              description: Initialization result message with resolved context values
          example: example_value
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Error code
            message:
              type: string
              description: Human-readable error message
            detail:
              type: string
              description: Detailed error information
          example: example_value
    LogoutResponse:
      type: object
      properties:
        response:
          type: object
          properties:
            data:
              type: string
              description: Logout confirmation message
          example: example_value
    LoginResponse:
      type: object
      properties:
        response:
          type: object
          properties:
            data:
              type: object
              properties:
                accessToken:
                  type: string
                  description: Session access token for subsequent requests
                accessTokenName:
                  type: string
                  description: Name of the access token cookie
                ebsVersion:
                  type: string
                  description: Oracle E-Business Suite version
                  example: 12.2.0
                userName:
                  type: string
                  description: Authenticated username
          example: example_value
    InitializeRequest:
      type: object
      properties:
        data:
          type: object
          properties:
            resp:
              type: object
              description: Responsibility context
              properties:
                id:
                  type: integer
                  description: Responsibility ID
                  example: 20872
                applId:
                  type: integer
                  description: Application ID
                  example: 178
                key:
                  type: string
                  description: Responsibility key (alternative to ID)
                  example: SYSTEM_ADMINISTRATION
                applKey:
                  type: string
                  description: Application key (alternative to applId)
                  example: ICX
            securityGroup:
              type: object
              description: Security group context
              properties:
                id:
                  type: integer
                  description: Security group ID
                  example: 0
                key:
                  type: string
                  description: Security group key
                  example: STANDARD
            org:
              type: object
              description: Organization context
              properties:
                id:
                  type: integer
                  description: Organization ID
                  example: 1733
                key:
                  type: string
                  description: Organization key
                  example: CM1
          example: example_value
  parameters:
    AcceptLanguage:
      name: Accept-Language
      in: header
      description: NLS language context in RFC 5646 format. Controls the language for translated messages and data returned by the service.
      schema:
        type: string
        default: en-US
      example: en-GB,en-US;q=0.8,en;q=0.6
    ContentType:
      name: Content-Type
      in: header
      description: The format of the request body
      schema:
        type: string
        enum:
        - application/json
        - application/xml
        default: application/json
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication with Oracle EBS username and password
    tokenAuth:
      type: apiKey
      in: cookie
      name: accessToken
      description: Token-based authentication using the ISG login access token