Set Import Options

Sets import options that specify how the import of group membership is handled during import of groups from a snapshot or file.

Required Roles

Service Administrator

REST Resource

POST /interop/rest/v2/migration/options/import/save

Request

Supported Media Types: application/json

Parameter	Description	Required	Type
optionName	The import option to set. The only acceptable option name is Groups and Membership - Import Mode.	Yes	Payload
optionValue	The import action to perform. Possible values are: Create/Update to add new groups or updates the group membership of existing groups in Access Control. Also, assigns or unassigns granular roles to users and groups. Create to add new groups. Changes made to existing group are not imported. Also, assigns granular roles for users and groups. Update to modify existing groups based on the information available in the import file. New groups are not added. Also, assigns or unassigns granular roles to users and groups. Delete to remove existing groups available in the import file. Also, unassigns granular roles from users and groups.	Yes	Payload

Request Payload Example:

Request:
{
    "options": [
        {
            "optionName": "Groups and Membership - Import Mode",
            "optionValue": "Create/Update"
        }
    ]
}

Response

A successful response reports status 0 as shown in this example.

{
    "status": 0,
    "items": null,
    "links": [
        {
            "href": "https://<BASE-URL>/interop/rest/v2/migration/options/import/save",
            "action": "POST",
            "rel": "self"
        }
    ]
}

Response for failed operation reports status 4:

{
    "status": 4,
    "details": "Invalid input. Please check it",
    "items": null,
    "links": [
        {
            "href": "https://<BASE-URL>/interop/rest/v2/migration/options/import/save",
            "action": "POST",
            "rel": "self"
        }
    ]
}