fieldMapping.json

{
    "Version": "v1",
    "MappingFields": [
        {
            "Name": "changePasswordNextSignIn",
            "Type": "Text",
            "MappingActions": [
                {
                    "MapForActions": [
                        "Create"
                    ],
                    "MappingMode": "Complex",
                    "Value": "\"function getValue() {\\n    return true\\n}\\n\\ngetValue()\"",
                    "UsedInNotifications": false,
                    "StoreInAccountData": false
                }
            ]
        },
        {
            "Name": "companyName",
            "Description": "The name of the company that the user is associated with. This property can be useful for describing the company that an external user comes from. The maximum length is 64 characters.",
            "Type": "Text",
            "MappingActions": [
                {
                    "MapForActions": [
                        "Create",
                        "Update"
                    ],
                    "MappingMode": "Field",
                    "Value": "\"Person.PrimaryContract.Organization.Name\"",
                    "UsedInNotifications": true,
                    "StoreInAccountData": true
                }
            ]
        },
        {
            "Name": "department",
            "Description": "The name of the department in which the user works. Maximum length is 64 characters.",
            "Type": "Text",
            "MappingActions": [
                {
                    "MapForActions": [
                        "Create"
                    ],
                    "MappingMode": "Field",
                    "Value": "\"Person.PrimaryContract.Department.DisplayName\"",
                    "UsedInNotifications": true,
                    "StoreInAccountData": true
                }
            ]
        },
        {
            "Name": "displayName",
            "Description": "The name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial, and last name. This property is required when a user is created and it cannot be cleared during updates. Maximum length is 256 characters. ",
            "Type": "Text",
            "MappingActions": [
                {
                    "MapForActions": [
                        "Create",
                        "Update"
                    ],
                    "MappingMode": "Field",
                    "Value": "\"Person.DisplayName\"",
                    "UsedInNotifications": true,
                    "StoreInAccountData": true
                }
            ]
        },
        {
            "Name": "employeeId",
            "Description": "The employee identifier assigned to the user by the organization. The maximum length is 16 characters.",
            "Type": "Text",
            "MappingActions": [
                {
                    "MapForActions": [
                        "Create",
                        "Update"
                    ],
                    "MappingMode": "Field",
                    "Value": "\"Person.ExternalId\"",
                    "UsedInNotifications": true,
                    "StoreInAccountData": true
                }
            ]
        },
        {
            "Name": "givenName",
            "Description": "The given name (first name) of the user. Maximum length is 64 characters.",
            "Type": "Text",
            "MappingActions": [
                {
                    "MapForActions": [
                        "Create",
                        "Update"
                    ],
                    "MappingMode": "Field",
                    "Value": "\"Person.Name.NickName\"",
                    "UsedInNotifications": true,
                    "StoreInAccountData": true
                }
            ]
        },
        {
            "Name": "jobTitle",
            "Description": "The user's job title. Maximum length is 128 characters. ",
            "Type": "Text",
            "MappingActions": [
                {
                    "MapForActions": [
                        "Create",
                        "Update"
                    ],
                    "MappingMode": "Field",
                    "Value": "\"Person.PrimaryContract.Title.Name\"",
                    "UsedInNotifications": true,
                    "StoreInAccountData": true
                }
            ]
        },
        {
            "Name": "officeLocation",
            "Description": "The office location in the user's place of business. ",
            "Type": "Text",
            "MappingActions": [
                {
                    "MapForActions": [
                        "Create",
                        "Update"
                    ],
                    "MappingMode": "Field",
                    "Value": "\"Person.PrimaryContract.Department.DisplayName\"",
                    "UsedInNotifications": true,
                    "StoreInAccountData": false
                }
            ]
        },
        {
            "Name": "preferredLanguage",
            "Description": "The preferred language for the user. The preferred language format is based on RFC 4646. The name is a combination of an ISO 639 two-letter lowercase culture code associated with the language and an ISO 3166 two-letter uppercase subculture code associated with the country or region. Example: \"en-US\", or \"es-ES\". ",
            "Type": "Text",
            "MappingActions": [
                {
                    "MapForActions": [
                        "Create"
                    ],
                    "MappingMode": "Fixed",
                    "Value": "\"nl-NL\"",
                    "UsedInNotifications": false,
                    "StoreInAccountData": false
                }
            ]
        },
        {
            "Name": "usageLocation",
            "Description": "A two-letter country code (ISO standard 3166). Required for users that are assigned licenses due to legal requirements to check for availability of services in countries. Examples include: US, JP, and GB. Not nullable.",
            "Type": "Text",
            "MappingActions": [
                {
                    "MapForActions": [
                        "Create"
                    ],
                    "MappingMode": "Fixed",
                    "Value": "\"NL\"",
                    "UsedInNotifications": false,
                    "StoreInAccountData": false
                }
            ]
        },
        {
            "Name": "surName",
            "Description": "The user's surname (family name or last name). Maximum length is 64 characters. ",
            "Type": "Text",
            "MappingActions": [
                {
                    "MapForActions": [
                        "Create",
                        "Update"
                    ],
                    "MappingMode": "Complex",
                    "Value": "\"function generateLastName() {\\n\\n    let birthName = [\\n        Person.Name.FamilyNamePrefix,\\n        Person.Name.FamilyName\\n    ].join(' ');\\n\\n    let partnerName = [\\n        Person.Name.FamilyNamePartnerPrefix,\\n        Person.Name.FamilyNamePartner\\n    ].join(' ');\\n    \\n    switch(Person.Name.Convention) {\\n        case \\\"B\\\":\\n            return birthName;\\n\\n        case \\\"P\\\":\\n            return partnerName;\\n\\n        case \\\"BP\\\":\\n            return [birthName, partnerName]\\n                .filter(function(x) {\\n                    return x !== \\\"\\\"\\n                })\\n                .join('-');\\n\\n        case \\\"PB\\\":\\n            return [partnerName, birthName]\\n                .filter(function(x) {\\n                    return x !== \\\"\\\"\\n                })\\n                .join('-');\\n\\n        default:\\n            return birthName;\\n    }\\n}\\n \\ngenerateLastName();\"",
                    "UsedInNotifications": true,
                    "StoreInAccountData": false
                }
            ]
        },
        {
            "Name": "userPrincipalName",
            "Description": "The user principal name (UPN) of the user. The UPN is an Internet-style sign-in name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is alias@domain, where the domain must be present in the tenant's collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization.",
            "Type": "Text",
            "MappingActions": [
                {
                    "MapForActions": [
                        "Create",
                        "Update"
                    ],
                    "MappingMode": "Complex",
                    "Value": "\"function generateUserPrincipalName() {\\n    const domain = 'yourdomainhere';\\n    const suffix = Iteration === 0 ? '' : Iteration;\\n\\n    let firstName = Person.Name.NickName.trim();\\n\\n    let lastName = ''\\n\\n    if ([\\\"P\\\", \\\"PB\\\"].includes(Person.Name.Convention)) {\\n        lastName = [\\n            Person.Name.FamilyNamePartnerPrefix,\\n            Person.Name.FamilyNamePartner\\n        ].join(' ')\\n    }\\n    else {\\n        lastName = [\\n            Person.Name.FamilyNamePrefix,\\n            Person.Name.FamilyName\\n        ].join(' ')\\n    }\\n        \\n    let userPrincipalName = [firstName, lastName]\\n        // Filter empty values\\n        .filter(function(x) {return x !== \\\"\\\"})\\n        // Join values to single string\\n        .join(' ')\\n        //Change whitespaces to dots\\n        .replace(/\\\\s+/g, '.')\\n        //Convert to lower case\\n        .toLowerCase()\\n    \\n    //Remove diacritical chars\\n    userPrincipalName = deleteDiacriticalMarks(userPrincipalName)\\n\\t    //Remove specific chars    \\n        .replace(/[^0-9a-zA-Z.']/g, '')\\n        .concat(suffix, '@', domain)\\n\\n    return userPrincipalName\\n}\\n\\ngenerateUserPrincipalName();\"",
                    "UsedInNotifications": false,
                    "StoreInAccountData": true
                }
            ]
        },
        {
            "Name": "businessPhones",
            "Description": "The telephone numbers for the user.\n\nNOTE: Although it is a string collection, only one number can be set for this property.",
            "Type": "Array",
            "MappingActions": [
                {
                    "MapForActions": [
                        "Create",
                        "Update"
                    ],
                    "MappingMode": "Complex",
                    "Value": "\"function getValue() {\\n    return [Person.Contact.Business.Phone.Mobile]\\n}\\n\\ngetValue()\"",
                    "UsedInNotifications": false,
                    "StoreInAccountData": false
                }
            ]
        },
        {
            "Name": "mail",
            "Description": "Setting the mapping to 'None' will force the UPN in this field.\n\nThe SMTP address for the user, for example, jeff@contoso.onmicrosoft.com. Changes to this property update the user's proxyAddresses collection to include the value as an SMTP address. This property can't contain accent characters.\n\nNOTE: We don't recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead.",
            "Type": "Text",
            "MappingActions": [
                {
                    "MapForActions": [
                        "Create",
                        "Update"
                    ],
                    "MappingMode": "None",
                    "Value": "\"\"",
                    "UsedInNotifications": false,
                    "StoreInAccountData": true
                }
            ]
        }
    ],
    "UniqueFieldNames": []
}