Getting Excluded Object by Object ID

You can get a resource representation of an object with the specified ID excluded from the scope of a restore operator role with the specified ID. Restore operators are not allowed to explore and restore data from backups created by Veeam Backup for Microsoft 365 for this object.

Request

GET https://<hostname>:4443/v6/RbacRoles/{roleId}/excludedItems/{itemId}

Request Headers

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

Request Parameters

The following parameters 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.

itemId

string

Specifies the identification number of the object excluded from the scope of the restore operator role. For more information on how to get this parameter, see Getting Excluded Objects.

Request Body

None.

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

In the response body, the server returns a resource representation of the /RbacRoles/{roleId}/excludedItems/{itemId} resource. The response body contains the following properties:

Property

Type

Description

user

User

Specifies a user excluded from the restore operator role scope.

site

Site

Specifies a site excluded from the restore operator role scope.

group

Group

Specifies a group excluded from the restore operator role scope.

id

String

Specifies an identification number of the excluded object.

type

String

Type of the excluded object. The following types are available:

  • User
  • Site
  • Group

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Example

The example returns a resource representation of the User type object excluded from the scope of the restore operator role with the ID 97edf1c9-74a1-480d-8b60-29b9ef331bd9. Restore operators are not allowed to explore and restore data from backups created by Veeam Backup for Microsoft 365 for this object.

Request:

GET https://abc.tech.local:4443/v6/RbacRoles/97edf1c9-74a1-480d-8b60-29b9ef331bd9/excludedItems/a4e58481-9bd5-4d41-9f46-01c14862f6f488b14a1f-c0bd-435a-9d18-7c703ff1fb1400000000-0000-0000-0000-000000000000

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "type": "User",

 "user": {

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

   "displayName": "Administrator",

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

   "type": "User"

 },

 "id": "a4e58481-9bd5-4d41-9f46-01c14862f6f488b14a1f-c0bd-435a-9d18-7c703ff1fb1400000000-0000-0000-0000-000000000000",

 "_links": {

   "self": {

     "href": "/v6/rbacRoles/97edf1c9-74a1-480d-8b60-29b9ef331bd9/excludedItems/a4e58481-9bd5-4d41-9f46-01c14862f6f488b14a1f-c0bd-435a-9d18-7c703ff1fb1400000000-0000-0000-0000-000000000000"

   },

   "rbacRole": {

     "href": "/v6/rbacRoles/97edf1c9-74a1-480d-8b60-29b9ef331bd9"

   }

 }

}