Getting Restore Operators

In this article

    You can get a resource representation of restore operators added to a restore operator role with the specified ID.

    Request

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

    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

    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}/operators collection resource. The response body contains the following properties:

    Property

    Type

    Description

    user

    User

    Specifies a user added as a restore operator.

    group

    Group

    Speccifies a group added as a restore operator.

    id

    String

    Specifies the restore operator ID.

    type

    String

    Type of the restore operator. The following types are available:

    • User
    • Group

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Example

    The example returns a resource representation of the restore operators added to the restore operator role with the ID 5b7b13ba-a04e-4e05-8eab-0084ae5410a0.

    Request:

    GET https://abc.tech.local:4443/v6/RbacRoles/5b7b13ba-a04e-4e05-8eab-0084ae5410a0/operators

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    [

     {

       "type": "User",

       "user": {

         "id": "369ae97d-8b25-4c96-8f0e-83a94fe9bd5400000000-0000-0000-0000-000000000000",

         "displayName": "John Smith",

         "name": "j.smith@abc.onmicrosoft.com",

         "type": "User"

       },

       "id": "75908e04-e13e-46ad-b11e-7a94a5632177369ae97d-8b25-4c96-8f0e-83a94fe9bd5400000000-0000-0000-0000-000000000000",

       "_links": {

         "self": {

           "href": "v6/rbacRoles/5b7b13ba-a04e-4e05-8eab-0084ae5410a0/operators/75908e04-e13e-46ad-b11e-7a94a5632177369ae97d-8b25-4c96-8f0e-83a94fe9bd5400000000-0000-0000-0000-000000000000"

         },

         "rbacRole": {

           "href": "v6/rbacRoles/5b7b13ba-a04e-4e05-8eab-0084ae5410a0"

         }

       }

     },

     {

       "type": "Group",

       "id": "b7f90a69-6de2-4e8d-ab2b-985a38191d517ace610a-ded5-4b14-8946-f039422b631d00000000-0000-0000-0000-000000000000",

       "_links": {

         "self": {

           "href": "v6/rbacRoles/5b7b13ba-a04e-4e05-8eab-0084ae5410a0/operators/b7f90a69-6de2-4e8d-ab2b-985a38191d517ace610a-ded5-4b14-8946-f039422b631d00000000-0000-0000-0000-000000000000"

         },

         "rbacRole": {

           "href": "v6/rbacRoles/5b7b13ba-a04e-4e05-8eab-0084ae5410a0"

         }

       },

       "group": {

         "id": "7ace610a-ded5-4b14-8946-f039422b631d00000000-0000-0000-0000-000000000000",

         "displayName": "Group1",

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

         "type": "Office365"

       }

     }

    ]