Grepr Users API

openapi: 3.2.0
info:
  title: Grepr Users API
  version: 1.0.0
  description: 'Operations tagged Users 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 users and access current user information
  name: Users
paths:
  /v1/me/login:
    post:
      operationId: recordLogin
      responses:
        default:
          content:
            application/json: {}
          description: default response
      security:
      - grepr-oidc: []
      tags:
      - Users
      summary: Record login
      x-summary-source: derived
  /v1/me/permissions:
    get:
      operationId: getUserPermissions
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPermissionsResponse'
          description: default response
      security:
      - grepr-oidc: []
      tags:
      - Users
      summary: Get user permissions
      x-summary-source: derived
  /v1/me/provision:
    put:
      operationId: provisionUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserProvisionInfo'
      responses:
        default:
          content:
            application/json: {}
          description: default response
      security:
      - grepr-oidc: []
      tags:
      - Users
      summary: Provision user
      x-summary-source: derived
  /v1/users:
    get:
      description: Get all users in the system.
      operationId: list_16
      parameters:
      - in: query
        name: page
        schema:
          default: 0
          format: int32
          minimum: 0
          type: integer
      - in: query
        name: pageSize
        schema:
          default: 10
          format: int32
          minimum: 1
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersListInfos'
          description: Users retrieved successfully
        '401':
          description: Unauthorized
        '403':
          description: Unauthorized
      security:
      - grepr-oidc: []
      summary: List all users
      tags:
      - Users
    post:
      description: Create a new user and add them to the organization.
      operationId: createUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUser'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadUser'
          description: User created successfully
        '400':
          description: Invalid user data
        '401':
          description: Unauthorized
        '403':
          description: Unauthorized
        '409':
          description: User already exists
      security:
      - grepr-oidc: []
      summary: Create a new user
      tags:
      - Users
  /v1/users/{id}:
    delete:
      operationId: deleteUser
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json: {}
          description: default response
      security:
      - grepr-oidc: []
      tags:
      - Users
      summary: Delete user
      x-summary-source: derived
    get:
      description: Get a user by their ID.
      operationId: getUser
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadUser'
          description: User retrieved successfully
        '401':
          description: Unauthorized
        '403':
          description: Unauthorized
        '404':
          description: User not found
      security:
      - grepr-oidc: []
      summary: Get user by ID
      tags:
      - Users
    put:
      operationId: updateUser
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WriteUser'
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadUser'
          description: default response
      security:
      - grepr-oidc: []
      tags:
      - Users
      summary: Update user
      x-summary-source: derived
  /v1/users/{id}/orgRoles:
    put:
      operationId: updateUserOrgRoles
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleIds'
      responses:
        default:
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Role'
                type: array
                uniqueItems: true
          description: default response
      security:
      - grepr-oidc: []
      tags:
      - Users
      summary: Update user org roles
      x-summary-source: derived
components:
  schemas:
    ReadUser:
      properties:
        email:
          description: The email associated with the user.
          type: string
        id:
          description: The id associated with the user.
          type: string
        name:
          description: The name of the user.
          type: string
        roles:
          default: []
          description: The roles associated with this user.
          items:
            $ref: '#/components/schemas/Role'
          type: array
          uniqueItems: true
        teamIds:
          description: The teams that this user is a member of.
          items:
            description: The teams that this user is a member of.
            type: string
          type: array
          uniqueItems: true
      required:
      - roles
      - teamIds
      type: object
    WriteUser:
      properties:
        email:
          description: The email associated with the user.
          type: string
        name:
          description: The name of the user.
          type: string
        roleIds:
          description: The roles associated with this user.
          example:
          - rol_AlphaNum1234
          - rol_alphaNum5678
          items:
            description: The roles associated with this user.
            example: '["rol_AlphaNum1234","rol_alphaNum5678"]'
            type: string
          type: array
          uniqueItems: true
      required:
      - roleIds
      type: object
    UserPermissionsResponse:
      properties:
        permissions:
          default: []
          items:
            type: string
          type: array
      type: object
    UsersListInfos:
      properties:
        limit:
          format: int32
          type: integer
        members:
          $ref: '#/components/schemas/ItemsCollectionReadUser'
        start:
          format: int32
          type: integer
        total:
          format: int32
          type: integer
      type: object
    ItemsCollectionReadUser:
      properties:
        items:
          default: []
          items:
            $ref: '#/components/schemas/ReadUser'
          type: array
      type: object
    SecretApi:
      description: Secret wrapper for API responses
      properties:
        secret:
          description: The secret value
          type: string
      required:
      - secret
      type: object
    CreateUser:
      properties:
        email:
          description: The email associated with the user.
          type: string
        firstName:
          description: The first name of the user.
          type: string
        lastName:
          description: The last name of the user.
          type: string
        password:
          $ref: '#/components/schemas/SecretApi'
        roleIds:
          description: The roles associated with this user.
          example:
          - rol_AlphaNum1234
          - rol_alphaNum5678
          items:
            description: The roles associated with this user.
            example: '["rol_AlphaNum1234","rol_alphaNum5678"]'
            type: string
          type: array
          uniqueItems: true
      required:
      - email
      - firstName
      - lastName
      - password
      - roleIds
      type: object
    RoleIds:
      description: The role IDs to assign to the user.
      example:
      - rol_AlphaNum1234
      - rol_alphaNum5678
      properties:
        roleIds:
          items:
            type: string
          type: array
          uniqueItems: true
      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
    UserProvisionInfo:
      properties:
        invitationTicketId:
          type: string
      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