Devtron RBAC API

Operations related to Role-Based Access Control, like fetching default roles.

OpenAPI Specification

devtron-rbac-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  version: 1.0.0
  title: Devtron APIs Specs Applications RBAC API
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  description: Application management operations including creation, listing, and updates
servers:
- url: http://localhost/orchestrator
  description: Local development server
tags:
- name: RBAC
  description: Operations related to Role-Based Access Control, like fetching default roles.
  x-displayName: RBAC
paths:
  /rbac/roles/default:
    get:
      tags:
      - RBAC
      summary: Get All Default Roles
      operationId: GetAllDefaultRoles
      responses:
        '200':
          description: List of default RBAC roles.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RbacRoleDto'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security: []
components:
  responses:
    Forbidden:
      description: Forbidden. User does not have permission.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Unauthorized. User is not logged in or token is invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          format: int32
        status:
          type: string
        result:
          type: object
          nullable: true
        errors:
          type: array
          items:
            type: object
            properties:
              userMessage:
                type: string
                nullable: true
              internalMessage:
                type: string
                nullable: true
    RbacRoleDto:
      type: object
      description: Represents a default RBAC role.
      properties:
        id:
          type: integer
          format: int32
        roleName:
          type: string
        roleDisplayName:
          type: string
        roleDescription:
          type: string
        entity:
          type: string
          enum:
          - apps
          - cluster
          - chart-group
          - jobs
        accessType:
          type: string
          nullable: true
x-tagGroups:
- name: Common Devtron automation APIs
  tags:
  - Metadata
  - Jobs
  - Helm Charts
  - List Applications
  - Applications
  - Labels
  - bulk_other
  - BulkUpdate
  - SSO Configuration
  - User Management
  - Role Group Management
  - RBAC
  - Authentication
  - Policy Management
  - Cache Management
  - Cluster Environment
  - Cluster Management
  - Environment Management
  - Change Chart
  - Clone Workflow
  - Deployment History
  - K8s Resource
  - Resource Recommendation
  - Workflow Management
  - Devtron Server version
  - GitOps Validation
  - Notifications