Translation Rules
Active Directory

Create Translation Rule

This endpoint allows you to create a new translation rule for a given Active Directory domain instance.

Sample Request

curl -X POST '[https://console.jumpcloud.com/api/v2/activedirectories/](https://console.jumpcloud.com/api/v2/activedirectories/){activedirectory_id}/translationrules' \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-org-id: {ORG_ID}' \
  -d '{
    "organization_object_id": "{ORG_ID_BASE64}",
    "domain_object_id": "{AD_ID_BASE64}",
    "translation_rule": {
      "source": "department",
      "destination": "customDepartment",
      "source_type": "PATH",
      "direction": "EXPORT",
      "applied_on": [
        "CREATE",
        "UPDATE"
      ]
    }
  }'
post/api/v2/activedirectories/{activedirectory_id}/translation-rules

Request

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Request body

appliedOnJumpcloudIdmAppliedOn[]

Operations when this translation rule is applied (CREATE, UPDATE)

destinationstring

Destination field path where translated value will be stored

direction'UNSPECIFIED' | 'EXPORT' | 'IMPORT'

Direction defines the direction of the attribute mapping.

sourcestring

Source field path or expression to be translated

sourceType'PATH' | 'GOLANG_TEMPLATE' | 'CONSTANT' | 'EXPR' | 'ENUMERATION'

SourceType defines the type of the source field in attribute mapping.

Response

The created translation rule's object ID.

Changes

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