Getting Restore Operator Roles

You can get a list of restore operator roles added to an organization with the specified ID.

Request

GET https://<hostname>:4443/v6/Organizations/{organizationId}/RbacRoles

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

organizationId

string

Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Getting Organizations.

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

The response body contains the following properties:

Property

Type

Description

id

string

An identification number of a restore operator role.

organizationId

string

Specifies the backed-up organization ID.

name

string

A restore operator role name.

description

string

Description of a 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.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Example

The example returns a resource representation of the restore operator roles added to an organization with the specified ID.

Request:

GET https://abc.tech.local:4443/v6/Organizations/e60dfb9c-ac58-4463-879f-9855ac35576b/RbacRoles

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

[

 {

   "id": "97edf1c9-74a1-480d-8b60-29b9ef331bd9",

   "organizationId": "e60dfb9c-ac58-4463-879f-9855ac35576b",

   "name": "Role1",

   "description": "",

   "roleType": "EntireOrganization",

   "_links": {

     "self": {

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

     },

     "organization": {

       "href": "/v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b"

     },

     "operators": {

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

     },

     "excludedItems": {

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

     }

   }

 },

 {

   "id": "342228aa-ebc6-407c-86cd-71929ebf0f6b",

   "organizationId": "e60dfb9c-ac58-4463-879f-9855ac35576b",

   "name": "Role2",

   "description": "",

   "roleType": "SpecificObjects",

   "_links": {

     "self": {

       "href": "/v6/rbacRoles/342228aa-ebc6-407c-86cd-71929ebf0f6b"

     },

     "organization": {

       "href": "/v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b"

     },

     "operators": {

       "href": "/v6/rbacRoles/342228aa-ebc6-407c-86cd-71929ebf0f6b/operators"

     },

     "selectedItem": {

       "href": "/v6/rbacRoles/342228aa-ebc6-407c-86cd-71929ebf0f6b/selectedItems"

     },

     "excludedItems": {

       "href": "/v6/rbacRoles/342228aa-ebc6-407c-86cd-71929ebf0f6b/excludedItems"

     }

   }

 }

]