> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tracecat.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Review Scim Activation

> Report what the provider pushed and what activating would change.

A read: the returned plan is not stored, so activation recomputes it.



## OpenAPI

````yaml https://platform.tracecat.com/api/openapi.json post /scim/activation/review
openapi: 3.1.0
info:
  title: Tracecat API
  summary: Tracecat API
  description: The open source AI automation platform for security teams and agents.
  termsOfService: >-
    https://docs.google.com/document/d/e/2PACX-1vQvDe3SoVAPoQc51MgfGCP71IqFYX_rMVEde8zC4qmBCec5f8PLKQRdxa6tsUABT8gWAR9J-EVs2CrQ/pub
  contact:
    name: Tracecat Founders
    email: founders@tracecat.com
  license:
    name: AGPL-3.0
    url: https://www.gnu.org/licenses/agpl-3.0.html
  version: '1'
servers:
  - url: /api
security: []
tags:
  - name: public
    description: Public facing endpoints
  - name: workflows
    description: Workflow management
  - name: actions
    description: Action management
  - name: triggers
    description: Workflow triggers
  - name: secrets
    description: Secret management
  - name: variables
    description: Workspace variable management
paths:
  /scim/activation/review:
    post:
      tags:
        - scim
      summary: Review Scim Activation
      description: |-
        Report what the provider pushed and what activating would change.

        A read: the returned plan is not stored, so activation recomputes it.
      operationId: scim-review_scim_activation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScimReviewRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimActivationReviewRead'
        '404':
          description: SCIM connection, mapping, or group not found.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyCookie: []
        - ServiceAccountApiKeyBearer: []
components:
  schemas:
    ScimReviewRequest:
      properties:
        mappings:
          items:
            $ref: '#/components/schemas/ExternalGroupMappingCreate'
          type: array
          maxItems: 100
          title: Mappings
        delete:
          items:
            type: string
            format: uuid
          type: array
          maxItems: 100
          title: Delete
        full:
          type: boolean
          title: Full
          default: false
      type: object
      title: ScimReviewRequest
      description: Mapping additions and removals to preview without applying them.
    ScimActivationReviewRead:
      properties:
        joining:
          $ref: '#/components/schemas/ScimReviewPeople'
        leaving:
          $ref: '#/components/schemas/ScimReviewPeople'
        losing:
          $ref: '#/components/schemas/ScimReviewPeople'
        to_idp:
          $ref: '#/components/schemas/ScimReviewPeople'
        to_manual:
          $ref: '#/components/schemas/ScimReviewPeople'
        groups:
          items:
            $ref: '#/components/schemas/ScimGroupTransitionRead'
          type: array
          title: Groups
      type: object
      required:
        - joining
        - leaving
        - losing
        - to_idp
        - to_manual
        - groups
      title: ScimActivationReviewRead
      description: Who a proposed activation or mapping change affects, by outcome.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ExternalGroupMappingCreate:
      properties:
        external_group_id:
          type: string
          format: uuid
          title: External Group Id
        group_id:
          type: string
          format: uuid
          title: Group Id
      type: object
      required:
        - external_group_id
        - group_id
      title: ExternalGroupMappingCreate
      description: Request to project an external group into a Tracecat group.
    ScimReviewPeople:
      properties:
        count:
          type: integer
          title: Count
        items:
          items:
            $ref: '#/components/schemas/ScimReviewPerson'
          type: array
          title: Items
      type: object
      required:
        - count
        - items
      title: ScimReviewPeople
      description: >-
        A counted list of people; ``items`` is a preview unless ``full`` was
        asked.
    ScimGroupTransitionRead:
      properties:
        group_id:
          type: string
          format: uuid
          title: Group Id
        group_name:
          type: string
          title: Group Name
        added_sources:
          items:
            type: string
          type: array
          title: Added Sources
        removed_sources:
          items:
            type: string
          type: array
          title: Removed Sources
        gained:
          type: integer
          title: Gained
        lost:
          type: integer
          title: Lost
        takes_over:
          type: boolean
          title: Takes Over
          default: false
      type: object
      required:
        - group_id
        - group_name
        - added_sources
        - removed_sources
        - gained
        - lost
      title: ScimGroupTransitionRead
      description: The combined effect of every proposed change on one Tracecat group.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ScimReviewPerson:
      properties:
        user_id:
          type: string
          format: uuid
          title: User Id
        email:
          type: string
          title: Email
        groups:
          items:
            type: string
          type: array
          title: Groups
      type: object
      required:
        - user_id
        - email
      title: ScimReviewPerson
      description: One person a review lists, with the Tracecat groups the change touches.
  securitySchemes:
    APIKeyCookie:
      type: apiKey
      in: cookie
      name: fastapiusersauth
    ServiceAccountApiKeyBearer:
      type: http
      description: Tracecat service account API key.
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.