Getting Objects to Manage

In this article

    Getting Objects to Manage Note

    Only Restore Portal users or restore operators can use this method. Make sure to obtain an authorization token with the operator value selected from the grant_type drop-down list. For more information on how to obtain a token, see Authorization for Restore Operators.

    You can get a resource representation of objects that are managed by the restore operators currently logged in to Restore Portal.

    Request

    GET https://<hostname>:4443/v6/Organization/LoggedInUser/EffectiveScope

    Request Headers

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

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

    Property

    Type

    Description

    user

    User

    Specifies a user added to the list of objects to manage.

    site

    Site

    Specifies a site added to the list of objects to manage.

    id

    String

    Identification number of the managed object.

    type

    String

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

    • User
    • Site

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Example

    The example returns a resource representation of objects that are managed by the restore operators currently logged in to Restore Portal.

    Request:

    GET https://abc.tech.local:4443/v6/Organization/LoggedInUser/EffectiveScope

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    {

     "users": [

       {

         "type": "User",

         "user": {

           "id": "c0564313-6070-4ebe-8af5-2d409b04698400000000-0000-0000-0000-000000000000",

           "displayName": "User1",

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

           "type": "User"

         },

         "id": "a4e58481-9bd5-4d41-9f46-01c14862f6f4c0564313-6070-4ebe-8af5-2d409b04698400000000-0000-0000-0000-000000000000",

         "_links": {}

       },

       {

         "type": "User",

         "user": {

           "id": "52a9e4ac-2378-4238-aba3-1ef840c9476300000000-0000-0000-0000-000000000000",

           "displayName": "User2",

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

           "type": "User"

         },

         "id": "a4e58481-9bd5-4d41-9f46-01c14862f6f452a9e4ac-2378-4238-aba3-1ef840c9476300000000-0000-0000-0000-000000000000",

         "_links": {}

       },

       {

         "type": "User",

         "user": {

           "id": "7ae2c943-57c6-4cf9-82df-5ac84c10b31000000000-0000-0000-0000-000000000000",

           "displayName": "User3",

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

           "type": "User"

         },

         "id": "a4e58481-9bd5-4d41-9f46-01c14862f6f47ae2c943-57c6-4cf9-82df-5ac84c10b31000000000-0000-0000-0000-000000000000",

         "_links": {}

       }

     ],

     "sites": [

       {

         "type": "Site",

         "site": {

           "id": "1d3740ca-bd0e-4656-88ed-2e35ce10e1deef4221af-9351-41ec-9128-534cf34db1a5",

           "url": "https://abc-my.sharepoint.com/personal/user1_abc_onmicrosoft_com",

           "title": "John Smith Site",

           "isCloud": true,

           "isPersonal": true

         },

         "id": "46c7c3c7-338e-4a28-b2de-e12c6936c9791d3740ca-bd0e-4656-88ed-2e35ce10e1deef4221af-9351-41ec-9128-534cf34db1a5",

         "_links": {}

       },

       {

         "type": "Site",

         "site": {

           "id": "ad751349-0ae9-4fca-8210-fb817d534bec7d4e60ec-c7c8-4bd5-9b19-e2a2770a1b47",

           "url": "https://abc-my.sharepoint.com/personal/user3_abc_onmicrosoft_com",

           "title": "",

           "isCloud": true,

           "isPersonal": true

         },

         "id": "46c7c3c7-338e-4a28-b2de-e12c6936c979ad751349-0ae9-4fca-8210-fb817d534bec7d4e60ec-c7c8-4bd5-9b19-e2a2770a1b47",

         "_links": {}

       }

     ]

    }