Oracle WebLogic Server Security API

openapi: 3.2.0
info:
  title: Oracle WebLogic Server Oracle WebLogic RESTful Management…
  description: RESTful API for managing and monitoring Oracle WebLogic Server domains, servers, clusters, applications, data sources, JMS resources, and security configuration.
  version: 12.2.1.3.0
  contact:
    name: Oracle Support
    url: https://support.oracle.com/
  license:
    name: Oracle Standard License
    url: https://www.oracle.com/downloads/licenses/standard-license.html
  termsOfService: https://www.oracle.com/legal/terms.html
servers:
- url: http://localhost:7001/management/weblogic/latest
  description: WebLogic Administration Server (default)
- url: http://{host}:{port}/management/weblogic/{version}
  description: WebLogic Administration Server (configurable)
  variables:
    host:
      default: localhost
      description: WebLogic admin server hostname
    port:
      default: '7001'
      description: WebLogic admin server listen port
    version:
      default: latest
      description: REST API version (e.g., latest, 12.2.1.3.0)
security:
- basicAuth: []
tags:
- name: Security
  description: Manage security realms, authentication providers, and users
paths:
  /edit/securityConfiguration/realms:
    get:
      operationId: listSecurityRealms
      summary: Oracle WebLogic Server List all security realms
      tags:
      - Security
      responses:
        '200':
          description: Collection of security realms
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/SecurityRealm'
    post:
      operationId: createSecurityRealm
      summary: Oracle WebLogic Server Create a security realm
      tags:
      - Security
      parameters:
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecurityRealmCreateRequest'
      responses:
        '201':
          description: Security realm created
  /edit/securityConfiguration/realms/{realmName}:
    get:
      operationId: getSecurityRealm
      summary: Oracle WebLogic Server Get a security realm configuration
      tags:
      - Security
      parameters:
      - $ref: '#/components/parameters/RealmName'
      responses:
        '200':
          description: Security realm configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityRealm'
    post:
      operationId: updateSecurityRealm
      summary: Oracle WebLogic Server Update a security realm
      tags:
      - Security
      parameters:
      - $ref: '#/components/parameters/RealmName'
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecurityRealm'
      responses:
        '200':
          description: Security realm updated
  /edit/securityConfiguration/realms/{realmName}/authenticationProviders:
    get:
      operationId: listAuthenticationProviders
      summary: Oracle WebLogic Server List authentication providers for a realm
      tags:
      - Security
      parameters:
      - $ref: '#/components/parameters/RealmName'
      responses:
        '200':
          description: Collection of authentication providers
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/AuthenticationProvider'
    post:
      operationId: createAuthenticationProvider
      summary: Oracle WebLogic Server Create an authentication provider
      tags:
      - Security
      parameters:
      - $ref: '#/components/parameters/RealmName'
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticationProviderCreateRequest'
      responses:
        '201':
          description: Authentication provider created
  /serverConfig/securityConfiguration/realms/{realmName}/authenticationProviders/{providerName}/createUser:
    post:
      operationId: createUser
      summary: Oracle WebLogic Server Create a user in an authentication provider
      description: Creates a new user in the specified authentication provider. This is an operation invoked on the serverConfig tree.
      tags:
      - Security
      parameters:
      - $ref: '#/components/parameters/RealmName'
      - $ref: '#/components/parameters/ProviderName'
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - userName
              - password
              properties:
                userName:
                  type: string
                  description: Username for the new user
                password:
                  type: string
                  format: password
                  description: Password for the new user
                description:
                  type: string
                  description: Description of the user
      responses:
        '200':
          description: User created successfully
  /serverConfig/securityConfiguration/realms/{realmName}/authenticationProviders/{providerName}/addMemberToGroup:
    post:
      operationId: addMemberToGroup
      summary: Oracle WebLogic Server Add a user or group to a security group
      tags:
      - Security
      parameters:
      - $ref: '#/components/parameters/RealmName'
      - $ref: '#/components/parameters/ProviderName'
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - groupName
              - memberUserOrGroupName
              properties:
                groupName:
                  type: string
                  description: Name of the group to add the member to
                memberUserOrGroupName:
                  type: string
                  description: Name of the user or group to add
      responses:
        '200':
          description: Member added to group
components:
  schemas:
    AuthenticationProvider:
      type: object
      properties:
        name:
          type: string
          description: Provider name
        type:
          type: string
          description: Fully qualified provider type class
    AuthenticationProviderCreateRequest:
      type: object
      required:
      - name
      - type
      properties:
        name:
          type: string
        type:
          type: string
          description: Provider type (e.g., weblogic.security.providers.authentication.DefaultAuthenticator)
        activeTypes:
          type: array
          items:
            type: string
          description: Active identity assertion types
    SecurityRealm:
      type: object
      properties:
        identity:
          type: array
          items:
            type: string
        name:
          type: string
          description: Security realm name
        managementIdentityDomain:
          type: string
          description: Identity domain for management
        certPathBuilder:
          type: array
          items:
            type: string
          description: Certificate path builder reference
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    Link:
      type: object
      properties:
        rel:
          type: string
          description: Link relation type
        href:
          type: string
          format: uri
          description: URL of the linked resource
        title:
          type: string
          description: Human-readable title for the link
    SecurityRealmCreateRequest:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: Security realm name
        managementIdentityDomain:
          type: string
  parameters:
    XRequestedBy:
      name: X-Requested-By
      in: header
      required: true
      description: CSRF protection header required for POST and DELETE requests
      schema:
        type: string
        example: MyClient
    RealmName:
      name: realmName
      in: path
      required: true
      description: Name of the security realm
      schema:
        type: string
    ProviderName:
      name: providerName
      in: path
      required: true
      description: Name of the authentication provider
      schema:
        type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using WebLogic Server credentials. Users must have appropriate roles (Admin, Operator, Deployer, or Monitor).
externalDocs:
  description: Oracle WebLogic Server RESTful Management Services Documentation
  url: https://docs.oracle.com/middleware/12213/wls/WLRUR/overview.htm