Editing Restore Operator Role Settings

In this article

    You can edit settings of a restore operator role with the specified ID.

    Request

    PUT https://<hostname>:4443/v6/RbacRoles/{roleId}

    Request Headers

    The request header must contain an authorization token of the current session.

    Request Parameters

    The following parameter must be specified in the URL of the request:

    Parameter

    Type

    Description

    roleId

    string

    Specifies the identification number of the restore operator role. For more information on how to get this parameter, see Getting Restore Operator Roles.

    Request Body

    The request body must contain the following properties:

    Property

    Type

    Description

    name

    string

    Specifies the name of the restore operator role.

    description

    string

    Specifies the description of the restore operator role.

    roleType

    string

    Specifies the restore operator role type. The following types are available:

    • EntireOrganization. Restore operators are allowed to explore and restore backed-up data of all objects (except teams) within the specified Microsoft 365 organization.
    • SpecificObjects. Restore operators are allowed to explore and restore backed-up data of the specified objects.

    Note: For the restore operator role of the SpecificObjects type, you must specify a collection of objects to manage. Restore operators will be able to explore and restore backed-up data of these objects. For more information about properties that you must specify for different types of objects to manage and objects that are excluded from the restore operator role scope, see selectedItems and excludedItems.

    operators

    restoreOperators

    Specifies one or more restore operators that you want to add to the restore operator role.

     

    selectedItems

    selectedItems

    Specifies one or more objects that you want to add to the restore operator role as objects to manage. Restore operators will be able to explore and restore data from backups created by Veeam Backup for Microsoft 365 for these objects.

    excludedItems

    excludedItems

    Specifies one or more objects that you want to exclude from the scope of the restore operator role. Restore operators will not be able to explore and restore data from backups created by Veeam Backup for Microsoft 365 for these objects.

    Request Example

    Request:

    PUT https://abc.tech.local:4443/v6/RbacRoles/97edf1c9-74a1-480d-8b60-29b9ef331bd9

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "name": "Restore Operator Role",

     "description": "edited role",

     "roleType": "EntireOrganization",

     "operators": [

       {

       "type": "User",

       "user": {

         "id": "6c6d2495-ca27-4b4a-8c93-956bacb8b4b400000000-0000-0000-0000-000000000000",

         "displayName": "Restore Operator",

         "name": "restore_operator@abc.onmicrosoft.com",

         "type": "User"

         }

       }

     ],

     "excludedItems": [

       {

         "type":"Group",

         "group": {

           "id": "acbf8c6c-dd8b-4a4c-8256-dd9a63077fa900000000-0000-0000-0000-000000000000",

           "displayName": "Excluded Objects",

           "name": "excluded@abc.onmicrosoft.com",

           "type": "Security"

         }

      }

    ]

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 200 OK.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the response body message: application/json; charset=utf-8

    Response Body

    None.

    Examples

    Example 1

    The example shows how to change the following settings of the restore operator role with the ID 97edf1c9-74a1-480d-8b60-29b9ef331bd9:

    • Name and description
    • The restore operator role type from SpecificObjects to EntireOrganization
    • The list of restore operators
    • The list of objects excluded from the restore operator role scope

    Request:

    PUT https://abc.tech.local:4443/v6/RbacRoles/97edf1c9-74a1-480d-8b60-29b9ef331bd9

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "name": "Restore Operator Role",

     "description": "edited role",

     "roleType": "EntireOrganization",

     "operators": [

       {

       "type": "User",

       "user": {

         "id": "6c6d2495-ca27-4b4a-8c93-956bacb8b4b400000000-0000-0000-0000-000000000000",

         "displayName": "Restore Operator",

         "name": "restore_operator@abc.onmicrosoft.com",

         "type": "User"

         }

       }

     ],

     "excludedItems": [

       {

         "type":"Group",

         "group": {

           "id": "acbf8c6c-dd8b-4a4c-8256-dd9a63077fa900000000-0000-0000-0000-000000000000",

           "displayName": "Excluded Objects",

           "name": "excluded@abc.onmicrosoft.com",

           "type": "Security"

         }

      }

    ]

     

    Response:

    200 OK

    Example 2

    The example shows how to change the following settings of the restore operator role with the ID 97edf1c9-74a1-480d-8b60-29b9ef331bd9:

    • The restore operator role type from EntireOrganization to SpecificObjects
    • The list of objects to manage
    • The list of objects excluded from the restore operator role scope

    Request:

    PUT https://abc.tech.local:4443/v6/RbacRoles/97edf1c9-74a1-480d-8b60-29b9ef331bd9

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "roleType": "SpecificObjects",

     "selectedItems": [

        {

       "type": "User",

       "user": {

         "id": "9bdd0fca-7210-450e-bfeb-c0dca2e1b36c00000000-0000-0000-0000-000000000000",

         "displayName": "User3",

         "name": "user3@abc.onmicrosoft.com",

         "type": "User"

       }

     },

     {

       "type": "Group",

       "group": {

         "id": "95e4e659-9039-45ef-826c-d1ba4b8e5d2500000000-0000-0000-0000-000000000000",

         "displayName": "ABC",

         "name": "abc1@abc.onmicrosoft.com",

         "type": "Office365"

       }

     },

     {

       "type": "Site",

       "site": {

         "id": "5359c4b5-5e3f-4fbb-a97f-a916bcba00a1ea863003-4637-4414-ad37-1757dd8f85cc",

         "url": "https://abc.sharepoint.com/sites/ABC_site",

         "title": "ABC_site",

         "isCloud": true,

         "isPersonal": false

       }

     }

     ],

     "excludedItems": [

       {

       "type": "User",

       "user": {

         "id": "88b14a1f-c0bd-435a-9d18-7c703ff1fb1400000000-0000-0000-0000-000000000000",

         "displayName": "Administrator",

         "name": "admin@abc.onmicrosoft.com",

         "type": "User"

         }

      }

    ]

     

    Response:

    200 OK