Grepr SSO Claim Mappings API

openapi: 3.2.0
info:
  title: Grepr SSO Claim Mappings API
  version: 1.0.0
  description: 'Operations tagged SSO Claim Mappings 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: Operations for managing SSO claim-to-role mappings
  name: SSO Claim Mappings
paths:
  /v1/sso-claim-mapping:
    get:
      description: Returns all configured SSO claim-to-role mappings for the organization
      operationId: listClaimMappings
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ReadSsoClaimMapping'
                type: array
          description: List of claim mappings retrieved successfully
        '403':
          description: Insufficient permissions
      summary: List all SSO claim mappings
      tags:
      - SSO Claim Mappings
    post:
      description: Creates a new SSO claim mapping that assigns roles when token claims match
      operationId: createClaimMapping
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WriteSsoClaimMapping'
      responses:
        '201':
          description: Claim mapping created successfully
        '400':
          description: Invalid request data (missing required fields, invalid role/team IDs, or validation failed)
        '403':
          description: Insufficient permissions
        '409':
          description: Claim mapping with this key-value pair already exists
      summary: Create a new SSO claim mapping
      tags:
      - SSO Claim Mappings
  /v1/sso-claim-mapping/{id}:
    delete:
      description: Deletes an existing SSO claim mapping
      operationId: deleteClaimMapping
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Claim mapping deleted successfully
        '403':
          description: Insufficient permissions
        '404':
          description: Claim mapping not found
      summary: Delete an SSO claim mapping
      tags:
      - SSO Claim Mappings
    get:
      description: Returns details of a specific SSO claim mapping
      operationId: getClaimMapping
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadSsoClaimMapping'
          description: Claim mapping retrieved successfully
        '403':
          description: Insufficient permissions
        '404':
          description: Claim mapping not found
      summary: Get claim mapping by ID
      tags:
      - SSO Claim Mappings
    put:
      description: Updates an existing SSO claim mapping
      operationId: updateClaimMapping
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WriteSsoClaimMapping'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadSsoClaimMapping'
          description: Claim mapping updated successfully
        '400':
          description: Invalid request data (missing required fields, invalid role/team IDs, or validation failed)
        '403':
          description: Insufficient permissions
        '404':
          description: Claim mapping not found
        '409':
          description: Claim mapping with this key-value pair already exists
      summary: Update an SSO claim mapping
      tags:
      - SSO Claim Mappings
components:
  schemas:
    ReadSsoClaimMapping:
      properties:
        claimKey:
          description: JWT claim key to match
          example: department
          type: string
        claimValue:
          description: JWT claim value to match
          example: engineering
          type: string
        createdAt:
          description: When the mapping was created
          example: '2026-03-09T00:00:00Z'
          format: date-time
          type: string
        id:
          description: Unique identifier of the claim mapping
          example: 0n2abc12345
          type: string
        roles:
          default: []
          description: Organization roles to assign when claim matches
          items:
            $ref: '#/components/schemas/SsoClaimMappingRole'
          type: array
        teamAssignments:
          default: []
          description: Team assignments to apply when claim matches
          items:
            $ref: '#/components/schemas/TeamAssignment'
          type: array
        updatedAt:
          description: When the mapping was last updated
          example: '2026-03-09T00:00:00Z'
          format: date-time
          type: string
      required:
      - claimKey
      - claimValue
      - createdAt
      - id
      - roles
      - teamAssignments
      - updatedAt
      type: object
    TeamAssignment:
      description: Team and role assignment
      properties:
        role:
          description: The role within the team
          enum:
          - LEADER
          - MEMBER
          type: string
        teamId:
          description: The ID of the team
          example: team123
          type: string
        teamName:
          description: Team name (response-only, enriched by server)
          readOnly: true
          type: string
      required:
      - role
      - teamId
      type: object
    SsoClaimMappingRole:
      description: Organization roles to assign when claim matches
      properties:
        id:
          description: Role identifier
          example: 0n1z6h5p0ffqz
          type: string
        name:
          description: Role name
          example: Admin
          type: string
      required:
      - id
      - name
      type: object
    WriteSsoClaimMapping:
      properties:
        claimKey:
          maxLength: 255
          minLength: 0
          type: string
        claimValue:
          maxLength: 512
          minLength: 0
          type: string
        roleIds:
          default: []
          items:
            type: string
          type: array
          uniqueItems: true
        teamAssignments:
          default: []
          items:
            $ref: '#/components/schemas/TeamAssignment'
          type: array
          uniqueItems: true
      required:
      - claimKey
      - claimValue
      - roleIds
      - teamAssignments
      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