IBM WebSphere Security API

openapi: 3.2.0
info:
  title: WebSphere Application Server Admin REST Security API
  description: REST API for administrative operations on IBM WebSphere Application Server including deployment, configuration, monitoring, and server management. Starting with version 9.0.0.1, Swagger documentation can be discovered and exposed for deployed RESTful endpoints.
  version: 9.0.5
  license:
    name: IBM International License Agreement
    url: https://www.ibm.com/legal/terms
  contact:
    name: IBM Support
    url: https://www.ibm.com/mysupport
servers:
- url: https://localhost:9443/ibm/api
  description: Default WebSphere Admin API Server
security:
- basicAuth: []
tags:
- name: Security
  description: Security configuration and management
paths:
  /security/users:
    get:
      operationId: listUsers
      summary: List Security Users
      description: Returns a list of users in the security registry.
      tags:
      - Security
      parameters:
      - name: pattern
        in: query
        description: Search pattern for user names
        schema:
          type: string
        example: example_value
      - name: limit
        in: query
        description: Maximum number of users to return
        schema:
          type: integer
          default: 50
        example: 10
      responses:
        '200':
          description: List of users
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
              examples:
                Listusers200Example:
                  summary: Default listUsers 200 response
                  x-microcks-default: true
                  value:
                  - uid: '500123'
                    displayName: example_value
                    email: user@example.com
                    groups:
                    - example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /security/roles:
    get:
      operationId: listRoles
      summary: List Security Roles
      description: Returns a list of administrative security roles.
      tags:
      - Security
      responses:
        '200':
          description: List of security roles
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SecurityRole'
              examples:
                Listroles200Example:
                  summary: Default listRoles 200 response
                  x-microcks-default: true
                  value:
                  - name: Example Title
                    description: A sample description.
                    users:
                    - example_value
                    groups:
                    - example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
        details:
          type: string
          example: example_value
      required:
      - code
      - message
    SecurityRole:
      type: object
      properties:
        name:
          type: string
          example: Example Title
        description:
          type: string
          example: A sample description.
        users:
          type: array
          items:
            type: string
          example: []
        groups:
          type: array
          items:
            type: string
          example: []
    User:
      type: object
      properties:
        uid:
          type: string
          example: '500123'
        displayName:
          type: string
          example: example_value
        email:
          type: string
          format: email
          example: user@example.com
        groups:
          type: array
          items:
            type: string
          example: []
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using WebSphere administrative credentials
    ltpaToken:
      type: apiKey
      in: cookie
      name: LtpaToken2
      description: LTPA token-based authentication
externalDocs:
  description: IBM WebSphere Application Server Documentation
  url: https://www.ibm.com/docs/en/was/9.0.5?topic=overview-administrative-rest-api