StackRox RoleService API

openapi: 3.0.0
info:
  title: API Reference AlertService RoleService 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: RoleService
paths:
  /v1/mypermissions:
    get:
      operationId: GetMyPermissions
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/storageRole'
      tags:
      - RoleService
  /v1/resources:
    get:
      operationId: GetResources
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1GetResourcesResponse'
      tags:
      - RoleService
  /v1/roles:
    get:
      operationId: GetRoles
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1GetRolesResponse'
      tags:
      - RoleService
  /v1/roles/{id}:
    get:
      operationId: GetRole
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/storageRole'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      tags:
      - RoleService
    delete:
      operationId: DeleteRole
      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:
      - RoleService
  /v1/roles/{name}:
    post:
      operationId: CreateRole
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Empty'
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/storageRole'
      tags:
      - RoleService
    put:
      operationId: UpdateRole
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1Empty'
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      requestBody:
        $ref: '#/components/requestBodies/storageRole'
      tags:
      - RoleService
components:
  schemas:
    storageRole:
      type: object
      properties:
        name:
          type: string
        globalAccess:
          $ref: '#/components/schemas/storageAccess'
        resourceToAccess:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/storageAccess'
    v1Empty:
      type: object
    v1GetRolesResponse:
      type: object
      properties:
        roles:
          type: array
          items:
            $ref: '#/components/schemas/storageRole'
    storageAccess:
      type: string
      enum:
      - NO_ACCESS
      - READ_ACCESS
      - READ_WRITE_ACCESS
      default: NO_ACCESS
    v1GetResourcesResponse:
      type: object
      properties:
        resources:
          type: array
          items:
            type: string
  requestBodies:
    storageRole:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/storageRole'
      required: true
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'StackRox API token. Format: Bearer {token}'