IBM WebSphere Security API

openapi: 3.1.0
info:
  title: Open Liberty APIs Applications Security API
  description: Open Liberty provides application programming interfaces that extend and complement Jakarta EE and MicroProfile APIs. Includes APIs for security, admin connectors, batch processing, messaging, health checking, metrics, OpenAPI documentation, and more. Open Liberty is the open-source foundation for WebSphere Liberty.
  version: 24.0.0
  license:
    name: Eclipse Public License 1.0
    url: https://www.eclipse.org/legal/epl-v10.html
  contact:
    name: Open Liberty Community
    url: https://openliberty.io/
servers:
- url: https://localhost:9443
  description: Default Open Liberty 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:
  schemas:
    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: []
    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: []
    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
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: MicroProfile JWT authentication
externalDocs:
  description: Open Liberty API Reference
  url: https://openliberty.io/docs/latest/reference/api/open-liberty-apis.html