Tackle.io Entitlements API

openapi: 3.2.0
info:
  title: SCIM Entitlements API
  description: 'A SCIM (System for Cross-domain Identity Management) 2.0 compliant API for managing users

    through Auth0. This API provides endpoints for user management operations following RFC 7644.


    The API supports:

    - User CRUD operations (Create, Read, Update, List)

    - SCIM 2.0 compliant error responses

    - Bearer token authentication

    - Enterprise user extensions'
  version: 2.0.0
  contact:
    name: Tackle.io
  license:
    name: Proprietary
servers:
- url: https://scim.tackle.io
  description: SCIM API Server
  variables:
    domain:
      default: scim-api.tackle.io
      description: The domain for the SCIM API
security:
- ApiKeyAuth: []
tags:
- name: Entitlements
  description: Legacy entitlements endpoint - returns flat role objects
paths:
  /scim/v2/Entitlements:
    get:
      tags:
      - Entitlements
      summary: Get Entitlements
      description: 'Returns available roles as flat entitlement objects.

        This is a legacy endpoint; prefer /scim/v2/Groups which returns

        full SCIM Group resources as required by identity providers.'
      operationId: getEntitlements
      responses:
        '200':
          description: Entitlements retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitlementListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    EntitlementListResponse:
      type: object
      required:
      - schemas
      - totalResults
      - startIndex
      - itemsPerPage
      - Resources
      properties:
        schemas:
          type: array
          items:
            type: string
          example:
          - urn:ietf:params:scim:api:messages:2.0:ListResponse
        totalResults:
          type: integer
          description: Total number of entitlements
          example: 3
        startIndex:
          type: integer
          description: 1-based index of the first result
          example: 1
        itemsPerPage:
          type: integer
          description: Number of entitlements in this response
          example: 3
        Resources:
          type: array
          items:
            $ref: '#/components/schemas/Entitlement'
    ScimError:
      type: object
      required:
      - schemas
      - status
      - detail
      properties:
        schemas:
          type: array
          items:
            type: string
          example:
          - urn:ietf:params:scim:api:messages:2.0:Error
        status:
          type: string
          description: HTTP status code as string
          example: '400'
        detail:
          type: string
          description: Human-readable error description
          example: Invalid request
        scimType:
          type: string
          description: SCIM-specific error type
          enum:
          - invalidFilter
          - tooMany
          - uniqueness
          - mutability
          - invalidSyntax
          - invalidPath
          - noTarget
          - invalidValue
          - invalidVers
          - sensitive
          example: invalidValue
    Entitlement:
      type: object
      required:
      - value
      - display
      - type
      properties:
        value:
          type: string
          description: The unique identifier of the entitlement (role ID)
          example: role_admin_123
        display:
          type: string
          description: The display name of the entitlement (role name)
          example: Administrator
        type:
          type: string
          description: The type of entitlement
          example: role
  responses:
    Forbidden:
      description: Access forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ScimError'
          example:
            schemas:
            - urn:ietf:params:scim:api:messages:2.0:Error
            status: '403'
            detail: Forbidden
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ScimError'
          example:
            schemas:
            - urn:ietf:params:scim:api:messages:2.0:Error
            status: '500'
            detail: Internal server error
    Unauthorized:
      description: Authentication information is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ScimError'
          example:
            schemas:
            - urn:ietf:params:scim:api:messages:2.0:Error
            status: '401'
            detail: Unauthorized
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'API key authentication.

        Include the API key in the Authorization header.

        '
externalDocs:
  description: SCIM 2.0 RFC 7644 Specification
  url: https://datatracker.ietf.org/doc/html/rfc7644