This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting Organization Users by Organization and User ID

In this article

    This section explains how to get a resource representation of organization users with the specified ID.

    Request

    GET https://<hostname>:4443/v4/Organizations/{organizationId}/Users/{userId}

    Request Headers

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

    Request Parameters

    The following parameters must be posted as URL.

    Parameter

    Type

    Description

    organizationId

    string

    An identification number of the organization.

    userId

    string

    An identification number of the user.

    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

    Property

    Type

    Description

    Id

    string

    User ID.

    DisplayName

    string

    A display name of the organization user.

    Name

    string

    The name of the organization user.

    IsBackedup

    boolean

    Specifies if this organization user is backed up.

    Type

    userType

    Specifies the user type :

    • User
    • Shared
    • Public

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Example

    Request:

    GET https://abc.tech.local:4443/v4/Organization/92460656-7a85-4a04-b1af-1ea903c0bc2e/Users/221fecc1-95f3-4da8-8ed2-101143dc117a00000000-0000-0000-0000-000000000000

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

    [

      {

         "id":"221fecc1-95f3-4da8-8ed2-101143dc117a00000000-0000-0000-0000-000000000000",

         "displayName":"Mailbox Test",

         "name":"mailboxtest@backup.onmicrosoft.com",

         "type":"User",

         "isBackedUp":false,

         "_links":{

            "self":{

               "href":"https://abc.tech.local:4443/v4/organizations/92460656-7a85-4a04-b1af-1ea903c0bc2e/users/221fecc1-95f3-4da8-8ed2-101143dc117a00000000-0000-0000-0000-000000000000"

            },

            "organization":{

               "href":"https://abc.tech.local:4443/v4/organizations/92460656-7a85-4a04-b1af-1ea903c0bc2e"

            },

            "onedrives":{

               "href":"https://abc.tech.local:4443/v4/organizations/92460656-7a85-4a04-b1af-1ea903c0bc2e/users/221fecc1-95f3-4da8-8ed2-101143dc117a00000000-0000-0000-0000-000000000000/onedrives"

            }

         }

      }

    ]

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.