Grepr Roles API

openapi: 3.2.0
info:
  title: Grepr Roles API
  version: 1.0.0
  description: 'Operations tagged Roles across 2 of this provider''s published API definitions: grepr-openapi.json, grepr.json. Each path carries the servers of the definition it was published in.'
tags:
- description: Manage roles and role assignments
  name: Roles
paths:
  /v1/roles:
    get:
      description: Returns all roles available for the organization
      operationId: listRoles
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Role'
                type: array
                uniqueItems: true
          description: List of roles retrieved successfully
        '403':
          description: Insufficient permissions
      summary: List all available roles for the organization
      tags:
      - Roles
    post:
      description: Creates a new custom role with specified permissions
      operationId: createRole
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRole'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
          description: Role created successfully
        '400':
          description: Invalid request data
        '403':
          description: Insufficient permissions
        '409':
          description: Role name already exists
      summary: Create a new custom role
      tags:
      - Roles
  /v1/roles/{roleId}:
    delete:
      description: Deletes a custom role. System roles cannot be deleted.
      operationId: deleteRole
      parameters:
      - in: path
        name: roleId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Role deleted successfully
        '400':
          description: Cannot delete system role or role in use
        '403':
          description: Insufficient permissions
        '404':
          description: Role not found
      summary: Delete a custom role
      tags:
      - Roles
    get:
      description: Returns details of a specific role by its ID
      operationId: getRoleById
      parameters:
      - in: path
        name: roleId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
          description: Role retrieved successfully
        '403':
          description: Insufficient permissions
        '404':
          description: Role not found
      summary: Get role by ID
      tags:
      - Roles
    put:
      description: Updates an existing custom role. System roles cannot be updated.
      operationId: updateRole
      parameters:
      - in: path
        name: roleId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRole'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
          description: Role updated successfully
        '400':
          description: Invalid request data or system role
        '403':
          description: Insufficient permissions
        '404':
          description: Role not found
        '409':
          description: Role name already exists
      summary: Update a custom role
      tags:
      - Roles
components:
  schemas:
    UpdateRole:
      properties:
        description:
          description: Description of the role
          maxLength: 500
          minLength: 0
          type: string
        name:
          description: The name of the role
          maxLength: 50
          minLength: 3
          type: string
        permissionIds:
          default: []
          description: Permission IDs to assign to this role
          example:
          - perm_001
          - perm_002
          items:
            description: Permission IDs to assign to this role
            example: '["perm_001","perm_002"]'
            type: string
          type: array
          uniqueItems: true
      required:
      - description
      - name
      - permissionIds
      type: object
    CreateRole:
      properties:
        description:
          description: Description of the role
          maxLength: 500
          minLength: 0
          type: string
        name:
          description: The name of the role
          maxLength: 50
          minLength: 3
          type: string
        permissionIds:
          default: []
          description: Permission IDs to assign to this role
          example:
          - perm_001
          - perm_002
          items:
            description: Permission IDs to assign to this role
            example: '["perm_001","perm_002"]'
            type: string
          type: array
          uniqueItems: true
      required:
      - description
      - name
      - permissionIds
      type: object
    Role:
      properties:
        builtin:
          default: false
          description: Whether this is a built-in role
          readOnly: true
          type: boolean
        createdAt:
          description: When the role was created (null for system roles)
          format: date-time
          type: string
        createdBy:
          description: Who created the role (null for system roles)
          type: string
        description:
          description: Description of the role
          type: string
        effect:
          default: allow
          description: 'The effect of this role''s permissions: ''allow'' or ''deny''. Defaults to ''allow'' for standard roles.'
          readOnly: true
          type: string
        id:
          description: The id of the role.
          type: string
        name:
          description: The user-facing name of the role.
          type: string
        permissionIds:
          default: []
          description: Permission IDs assigned to this role (empty for system roles)
          items:
            description: Permission IDs assigned to this role (empty for system roles)
            type: string
          type: array
          uniqueItems: true
      required:
      - description
      - id
      - name
      - permissionIds
      type: object
  securitySchemes:
    grepr-api-key:
      in: header
      name: GREPR-API-KEY
      type: apiKey
    grepr-oidc:
      bearerFormat: JWT
      openIdConnectUrl: https://grepr-prod.us.auth0.com/.well-known/openid-configuration
      type: openIdConnect
x-refined-from:
- grepr-openapi.json
- grepr.json
x-tagGroups:
- name: Integrations
  tags:
  - Grepr-hosted Data Warehouse Integration
  - External S3 Data Warehouse Integration
  - Datadog Integration
  - New Relic Integration
  - Splunk Integration
  - Sumo Logic Integration
  - OpenTelemetry Integration
- name: Pipelines
  tags:
  - Jobs
  - Templates
  - Datasets
  - Status Metrics
  - External Triggers
  - Job Actions
  - Triggers
- name: Pipeline Components
  tags:
  - Operations
  - Transforms
  - Sources
  - Sinks
- name: Administration
  tags:
  - Users
  - Teams
  - Roles
  - Permission
  - Invitations
  - Activity Logs
- name: Organization
  tags:
  - Organizations
  - Access Configuration
  - Grepr API Key
  - Service Accounts
  - Signup
- name: Query & Analysis
  tags:
  - Job Anomalies
  - Grok Parsing
  - Query Parsing
  - Validation
- name: System
  tags:
  - Manifest