Getting Azure Service Account Properties by Account ID

In this article

    You can get information about Microsoft Azure service account with the specified ID.

    Request

    GET https://<hostname>:4443/v6/AzureServiceAccounts/{id}

    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

    id

    string

    Specifies the identification number of Microsoft Azure service account. For more information on how to get this parameter, see Getting Azure Service Accounts.

    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

    Specifies the Microsoft Azure service account ID.

    type

    string

    Specifies the Microsoft Azure service account type.

    displayName

    string

    Specifies a name of Azure AD application associated with Microsoft Azure service account.

    description

    string

    Specifies a description of Microsoft Azure service account.

    applicationId

    string

    Specifies an Azure AD application ID.

    applicationCertificateThumbprint

    string

    Specifies an application certificate thumbprint for connecting to Microsoft Azure.

    azureEnvironment

    string

    Specifies a Microsoft Azure region. The following values are available:

    • Global
    • Germany
    • China
    • Government

    azureTenantId

    string

    Specifies the Microsoft 365 organization ID in Microsoft Azure.

    lastModified

    UTC

    Specifies date and time of the latest modification of Microsoft Azure service account.

    Example

    The example shows how to get properties of Microsoft Azure service account with the ID 676705f3-b1bf-49bd-878f-9085865bfcf9.

    Request:

    GET https://abc.tech.local:4443/v6/AzureServiceAccounts/676705f3-b1bf-49bd-878f-9085865bfcf9

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

     {

         "id": "676705f3-b1bf-49bd-878f-9085865bfcf9",

         "type": "Azure",

         "displayName": "Application",

         "applicationId": "2415230b-51ea-4e2d-a924-54c700a5431a",

         "applicationCertificateThumbprint": "FF2577A7586ACAD713FEBA43C62B67C1603CF7EC",

         "azureEnvironment": "Global",

         "azureTenantId": "4568fse5-48b8-4f24-b3f0-ce8a4078ca3f",

         "lastModified": "2022-02-16T17:46:16.8070443Z"

      }