---
title: "Start permission synchronization"
url: "https://nov18-dev.movespot.fyi/apis/internal-pdp-auth-admin-api-v1-1/versions/65945f7f-ee1f-40d6-be36-704dd7f85fcb/operations/startPermSync"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/internal-pdp-auth-admin-api-v1-1/versions/65945f7f-ee1f-40d6-be36-704dd7f85fcb.md

# Start permission synchronization

`POST` `/perm-sync/start`

Operation ID: `startPermSync`

Initiates permission synchronization process

## Request body (required)

Content types: `application/json`

## Responses

- `204` - Permission sync started successfully (no content)
- `400` - Bad Request

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Internal PDP Auth Admin API v1
  version: 1.0.0
servers:
  - url: http://authorization-admin-api.kauth.svc.cluster.local:8000/v1
    description: Konnect cluster
paths:
  /perm-sync/start:
    post:
      operationId: startPermSync
      summary: Start permission synchronization
      description: Initiates permission synchronization process
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/StartPermSyncRequest"
      responses:
        "204":
          description: Permission sync started successfully (no content)
        "400":
          $ref: "#/components/responses/BadRequest"
      tags:
        - Permission Sync
components:
  schemas:
    StartPermSyncRequest:
      description: Request body for starting permission synchronization
      type: object
      properties:
        targeting:
          description: Targeting configuration dictating which organizations to sync
          type: object
          properties:
            organization_ids:
              description: List of organization UUIDs to target (required when on=enumerated)
              type: array
              items:
                type: string
                format: uuid
              example:
                - 550e8400-e29b-41d4-a716-446655440000
                - 6ba7b810-9dad-11d1-80b4-00c04fd430c8
            on:
              description: Targeting type
              type: string
              example: enumerated
              enum:
                - enumerated
                - internal
                - all
        roles:
          description: List of role identifiers to sync in format domain#name
          type: array
          items:
            type: string
            pattern: ^[^#]+#[^#]+$
          example:
            - accounts#AppAuthStrategyCreator
            - accounts#PortalAdmin
        teams:
          description: List of team identifiers to sync in format domain#name
          type: array
          items:
            type: string
            pattern: ^[^#]+#[^#]+$
          example:
            - accounts#AnalyticsAdmin
            - accounts#AnalyticsViewer
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
```
