StackRox ScopedAccessControlService API

openapi: 3.0.0
info:
  title: API Reference AlertService ScopedAccessControlService API
  version: '1'
  description: API reference for the StackRox Kubernetes Security Platform (upstream of Red Hat Advanced Cluster Security). Provides risk analysis, visibility, runtime alerts, policy management, compliance checking, and vulnerability management for containerized workloads. Authentication uses API tokens generated via /v1/apitokens/generate and passed as Bearer tokens.
  contact:
    email: support@stackrox.com
    url: https://www.stackrox.io/
  license:
    name: All Rights Reserved
    url: https://www.stackrox.com/
servers:
- url: https://{central-host}
  description: StackRox Central API server
  variables:
    central-host:
      default: stackrox.localhost
      description: StackRox Central hostname or IP
security:
- ApiToken: []
tags:
- name: ScopedAccessControlService
paths:
  /v1/scopedaccessctrl/config:
    post:
      operationId: AddAuthzPluginConfig
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/storageAuthzPluginConfig'
      requestBody:
        $ref: '#/components/requestBodies/storageAuthzPluginConfig'
      tags:
      - ScopedAccessControlService
  /v1/scopedaccessctrl/config/{config.id}:
    put:
      operationId: UpdateAuthzPluginConfig
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/storageAuthzPluginConfig'
      parameters:
      - name: config.id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/storageAuthzPluginConfig'
      tags:
      - ScopedAccessControlService
  /v1/scopedaccessctrl/config/{id}:
    delete:
      operationId: DeleteAuthzPluginConfig
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Empty'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      tags:
      - ScopedAccessControlService
  /v1/scopedaccessctrl/configs:
    get:
      operationId: GetAuthzPluginConfigs
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1GetAuthzPluginConfigsResponse'
      tags:
      - ScopedAccessControlService
  /v1/scopedaccessctrl/test:
    post:
      operationId: DryRunAuthzPluginConfig
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Empty'
      requestBody:
        $ref: '#/components/requestBodies/storageAuthzPluginConfig'
      tags:
      - ScopedAccessControlService
components:
  schemas:
    v1Empty:
      type: object
    v1GetAuthzPluginConfigsResponse:
      type: object
      properties:
        configs:
          type: array
          items:
            $ref: '#/components/schemas/storageAuthzPluginConfig'
    storageAuthzPluginConfig:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        enabled:
          type: boolean
          format: boolean
        endpointConfig:
          $ref: '#/components/schemas/storageHTTPEndpointConfig'
    storageHTTPEndpointConfig:
      type: object
      properties:
        endpoint:
          type: string
        skipTlsVerify:
          type: boolean
          format: boolean
        caCert:
          type: string
        username:
          type: string
        password:
          type: string
        headers:
          type: array
          items:
            $ref: '#/components/schemas/storageKeyValuePair'
        clientCertPem:
          type: string
        clientKeyPem:
          type: string
    storageKeyValuePair:
      type: object
      properties:
        key:
          type: string
        value:
          type: string
  requestBodies:
    storageAuthzPluginConfig:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/storageAuthzPluginConfig'
      required: true
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'StackRox API token. Format: Bearer {token}'