Translation Rules
Active Directory

Preview of Translation Rules

This endpoint previews the translation rules for a user.

Sample Request

curl -X POST '[https://console.jumpcloud.com/api/v2/activedirectories/](https://console.jumpcloud.com/api/v2/activedirectories/){activedirectory_id}/translationrules/preview' \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-org-id: {ORG_ID}' \
  -d '{
    "userObjectId": "{USER_ID_HEX}",
    "idmTranslationRules": [
      {
        "source": "department",
        "destination": "customDepartment",
        "sourceType": "PATH",
        "direction": "IMPORT",
        "appliedOn": [
          "CREATE"
        ]
      }
    ]
  }'
post/activedirectories/translation-rules/preview

Request

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Request body

userObjectIdstring hex required

The unique identifier (Object ID) of the user whose data will be translated.

activeDirectoryIdstring hex

The ObjectID of the Active Directory instance. Optional parameter to specify which Active Directory instance to use for the preview.

Response

Result of the preview operation.

destinationUserstring

The user data after the translation rules have been applied. This represents the final state in the destination system (e.g., JumpCloud).

sourceUserstring

The original user data from the source system (e.g., Active Directory) before any translation rules were applied.

Changes

No recorded changes to this operation across all 1 revision of this API.