Era.Common.DataDefinition.Task.Server.StaffThirdPartyResourceSynchronization

Description

Staff groups and staff synchronization using AD/LDAP

Properties

Name JsonSchemaType Description
activeDirectorySettings reference to Era.Common.DataDefinition.Task.Server.StaffThirdPartyResourceSynchronization_ActiveDirectorySettings ActiveDirectory/LDAP synchronization settings. If not set server settings will be used
placeholderGroupDescription string
placeholderGroupName string
placeholderStaffDescription string
placeholderStaffName string
staffCollisionHandling enum of Era.Common.DataDefinition.Users.CollisionHandling Resolution of name conflicts for staff already present in ERA and those added via synchronization. Checks only apply to the names of users outside the subtree being synchronized.
staffExtinctionHandling enum of Era.Common.DataDefinition.Task.Server.StaffThirdPartyResourceSynchronization_ExtinctionHandling Action to take when the present staff does not exist in the synchronization sources (for example, Active Directory).
staffGroupExtinctionHandling enum of Era.Common.DataDefinition.Task.Server.StaffThirdPartyResourceSynchronization_ExtinctionHandling Action to take when the present staff group does not exist in the synchronization sources (for example, Active Directory).
staffGroupUuid reference to Era.Common.DataDefinition.Common.Uuid Target staff group into which directory tree will be synchronized.
userDataPlaceholders reference to Era.Common.DataDefinition.Users.UserData
userGroupPlaceHolders reference to Era.Common.DataDefinition.Users.UserGroupData Placeholder values loaded from AD hierarchy per user

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.DataDefinition.Task.ServerTaskConfiguration

JsonSchema

{
    "title": "Era.Common.DataDefinition.Task.Server.StaffThirdPartyResourceSynchronization",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Task.Server.StaffThirdPartyResourceSynchronization"
    ],
    "properties": {
        "Era.Common.DataDefinition.Task.Server.StaffThirdPartyResourceSynchronization": {
            "$ref": "#/definitions/StaffThirdPartyResourceSynchronization"
        }
    },
    "definitions": {
        "StaffThirdPartyResourceSynchronization": {
            "additionalProperties": false,
            "required": [
                "placeholderGroupName",
                "placeholderStaffName",
                "staffGroupUuid",
                "userDataPlaceholders",
                "userGroupPlaceHolders"
            ],
            "type": "object",
            "properties": {
                "activeDirectorySettings": {
                    "$ref": "Era.Common.DataDefinition.Task.Server.StaffThirdPartyResourceSynchronization_ActiveDirectorySettings#/definitions/StaffThirdPartyResourceSynchronization_ActiveDirectorySettings"
                },
                "placeholderGroupDescription": {
                    "type": "string"
                },
                "placeholderGroupName": {
                    "type": "string"
                },
                "placeholderStaffDescription": {
                    "type": "string"
                },
                "placeholderStaffName": {
                    "type": "string"
                },
                "staffCollisionHandling": {
                    "enum": [
                        1,
                        2
                    ]
                },
                "staffExtinctionHandling": {
                    "enum": [
                        1,
                        2
                    ]
                },
                "staffGroupExtinctionHandling": {
                    "enum": [
                        1,
                        2
                    ]
                },
                "staffGroupUuid": {
                    "$ref": "Era.Common.DataDefinition.Common.Uuid#/definitions/Uuid"
                },
                "userDataPlaceholders": {
                    "$ref": "Era.Common.DataDefinition.Users.UserData#/definitions/UserData"
                },
                "userGroupPlaceHolders": {
                    "$ref": "Era.Common.DataDefinition.Users.UserGroupData#/definitions/UserGroupData"
                }
            }
        }
    }
}