Breaking Changes

What are breaking changes?

In cases where a new resource type is added, a resource gets a new optional parameter or a parameter that used to be mandatory becomes optional, existing configurations are not impacted. But when a resource or parameter is removed or an optional parameter becomes mandatory, existing configurations can stop functioning, because they are using these removed or changed components. That is what is called a “Breaking Change”: A change that can break existing configurations and therefore impact the administration process with TMF.

TMF 1.6.2268-preview

With TMF version 1.6.2268-preview it was necessary to switch from the standard beta endpoint to the v1.0 endpoint for accessPackageAssignmentPolicies, because the autoAssignmentPolicy capabilities are only available in the v1.0 endpoint. This change leads to the necessity to adjust existing configurations for accessPackageAssignmentPolicies to the format of the v1.0 endpoint.

Beta endpoint definition:

{
    "displayName":"Access Package",
    "description":"Access Package description",
    "isHidden":true,
    "isRoleScopesVisible":true,
    "catalog":"General",
    "present":true,
    "accessPackageResources":[
        {
            "resourceIdentifier":"Some group",
            "resourceRole":"Member",
            "originSystem":"AadGroup"
        }
    ],
    "assignmentPolicies":[
        {
            "displayName":"Initial policy",
            "canExtend":false,
            "durationInDays":8,
            "accessReviewSettings":{
                "isEnabled":false,
                "recurrenceType":"monthly",
                "reviewerType":"Reviewers",
                "durationInDays":14,
                "reviewers":[
                    {
                        "type":"singleUser",
                        "reference":"[email protected]",
                        "isBackup":false
                    },
                    {
                        "type":"requestorManager",
                        "managerLevel":1,
                        "isBackup":false
                    }
                ]
            },
            "requestApprovalSettings":{
                "isApprovalRequired":true,
                "isApprovalRequiredForExtension":false,
                "isRequestorJustificationRequired":true,
                "approvalMode":"SingleStage",
                "approvalStages":[
                    {
                        "approvalStageTimeOutInDays":14,
                        "isApproverJustificationRequired":true,
                        "isEscalationEnabled":false,
                        "escalationTimeInMinutes":11520,
                        "primaryApprovers":[
                            {
                                "type":"singleUser",
                                "reference":"[email protected]",
                                "isBackup":false
                            }
                        ]
                    }
                ]
            },
            "requestorSettings":{
                "scopeType":"SpecificDirectorySubjects",
                "acceptRequests":true,
                "allowedRequestors":[
                    {
                        "type":"singleUser",
                        "reference":"[email protected]",
                        "isBackup":false
                    }
                ]
            }
        }
    ]
}   

v1.0 endpoint definition:

{	
    "displayName":  "Sample package",
    "oldNames": [],
    "description":  "This is a sample access package.",
    "isHidden":  false,
    "isRoleScopesVisible":  true,
    "catalog":  "Sample catalog",
    "present":  true,
    "accessPackageResources":  [
        {
            "originSystem":  "AadGroup",
            "resourceRole":  "Member",
            "resourceIdentifier":  "Some group"
        }
    ],
    "assignmentPolicies": [
        {
            "displayName": "Sample assignment policy",
            "description": "Access Package Assignment Policy has been created with Tenant Management Framework",
            "allowedTargetScope": "specificDirectoryUsers",
            "present": true,
            "specificAllowedTargets": [
                {
                    "reference": "Some group",
                    "type": "groupMembers",
                    "description": "Some group"
                }
            ],
            "expiration": {
                "endDateTime": null,
                "duration": "P90D",
                "type": "afterDuration"
            },
            "requestorSettings": {
                "enableTargetsToSelfAddAccess": true,
                "enableTargetsToSelfUpdateAccess": false,
                "enableTargetsToSelfRemoveAccess": true,
                "allowCustomAssignmentSchedule": true,
                "enableOnBehalfRequestorsToAddAccess": true,
                "enableOnBehalfRequestorsToUpdateAccess": false,
                "enableOnBehalfRequestorsToRemoveAccess": false,
                "onBehalfRequestors": []
            },
            "requestApprovalSettings": {
                "isApprovalRequiredForAdd": true,
                "isApprovalRequiredForUpdate": true,
                "stages": [
                    {
                        "durationBeforeAutomaticDenial": "P14D",
                        "isApproverJustificationRequired": true,
                        "isEscalationEnabled": false,
                        "durationBeforeEscalation": "P5D",
                        "primaryApprovers": [
                            {
                                "reference": "Some group",
                                "type": "groupMembers",
                                "description": "Some group"
                            }
                        ],
                        "fallbackPrimaryApprovers": [],
                        "escalationApprovers": [
                            {
                                "reference": "[email protected]",
                                "type": "singleUser"
                            }
                        ],
                        "fallbackEscalationApprovers": []
                    }
                ]
            },
            "reviewSettings": {
                "isEnabled": true,
                "expirationBehavior": "keepAccess",
                "isRecommendationEnabled": true,
                "isReviewerJustificationRequired": true,
                "isSelfReview": true,
                "schedule": {
                    "startDateTime": "2023-04-18T09:34:49.4485321Z",
                    "expiration": {
                        "endDateTime": null,
                        "duration": "P7D",
                        "type": "afterDuration"
                    },
                    "recurrence": {
                        "pattern": {
                            "type": "absoluteMonthly",
                            "interval": 1,
                            "month": 0,
                            "dayOfMonth": 0,
                            "daysOfWeek": [],
                            "firstDayOfWeek": null,
                            "index": null
                        },
                        "range": {
                            "type": "noEnd",
                            "numberOfOccurrences": 0,
                            "recurrenceTimeZone": null,
                            "startDate": null,
                            "endDate": null
                        }
                    }
                },
                "primaryReviewers": [
                    {
                        "reference": "Some group",
                        "type": "groupMembers",
                        "description": "Some group"
                    }                    
                ],
                "fallbackReviewers": []
            }
        }
    ]
}