This is an archive version of the document. To get the most up-to-date information, see the current version.Adding Azure Service Accounts
You can add a new Microsoft Azure service account.
Request
Request Headers
The request header must contain an authorization token of the current session.
Request Body
The request body must contain the following properties:
Property | Type | Description |
|---|---|---|
applicationName | 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 the Azure AD application ID. |
azureEnvironment | string | Specifies a Microsoft Azure region. The following values are available:
|
azureTenantId | string | Specifies the Microsoft 365 organization ID in Microsoft Azure. |
applicationCertificate | string | Specifies the Base64 string of an SSL certificate that you want to use to access the Azure AD application. |
applicationCertificatePassword | string | Specifies the password for the specified certificate. |
applicationSecret | string | Specifies an application secret for connecting to Microsoft Azure. |
userCode | string | Specifies the code that you must copy and then specify on the Microsoft authentication portal. |
subscriptionIds | string[] | Specifies an array of subscriptions associated with a user account that was used to sign in to Microsoft Azure. For more information on how to get this parameter, see Getting Subscriptions. |
Request Example
The following example shows how to add a new Microsoft Azure service account using the existing Azure AD application with application certificate.
Request: POST https://abc.tech.local:4443/v6/AzureServiceAccounts
Request Header: Authorization: Bearer <Access-Token>
{ "applicationId": "2415230a-51ea-4e0d-a924-54c699a5431a", "azureEnvironment": "Global", "azureTenantId": "4468fde5-48b8-4f24-b3f0-ce8a4078ca3f", "applicationCertificate": "MIIJlAIBAzCCCVAGCSqGSIb3DQEHAaCCCUEEggk9MIIJOTCCBfoGCSqGSIb3DQEHAaCCBesEggXnMIIF4zCCBd8GCyqGSIb3DQEMCgECoIIE/jCCBPowHAYKKoZIhvcNAQwBAzAOBAg3cDJaX9AnIgICB9AEggTYogR0zaA/PYUKvpJwCvOdWpngoz4AH4rp6PxiayN0KHfNhW3e4O1D2O7Z/qAcUEs3Eseph08gonpzJmvdADfUzFclWgh1cICkDCbwviV2QznDEooekxEKH5XLAHtvlreIxUoJbRNTv/UsGRck+StJ3bFG/qYkYs1a62KnZ41Ytu4L1lu0wi9RVIVvUSEQuFJ5JaY4BeXOpwBPocMaRT43Zm1RfbMes3m/TBv46j9cNBG/eucIrEmo5eIedygUb+PC0AJAjcUJYT345sySOhbeWgxWipFW2NI5vcxrL8F6Csj4uGGzTmgkn7xJKGqNkSpWrmecDxbKTMM6ZQKaXU+GTRAS32D+zlNqGB8Q33TsDtgoJoKifXEMCwxarIbQgx+lLBEpaozGBzGWZP4mA9soSjWK5CfgLNEED2NNXj4wcgztAh2ytYQ+1LATKocH9u6Auik2RP0gk5hu4MGCOHYhliMYQyECdV73MyzzYl7YtPA8+EqMmoU5bAaFf0O/cQUHMlKfY1QZ4bUFMbOULFHz52Ah+dumAIpVIxotyjWVmb4tyIUUiZeNfliGpyyGa4Dzete2ZmKiVjosx/LNcvxoBfMoXkFmlRIYjewWv9MJZLaXUM4hYThNh1BeaPf3f/M0dvDYQINxl6K2XfyksUc61SxJFHD/TLOhgMNR/NhRdRs8j+H9CXv1bW7QcKTsTK//s7Lf7PDzj0xk+eEcQyq9+Yucdi1G+g1rtFr4FJdfKuK9jtUUJ+4T2Ac2MqKskB41t/HoKj7avrwa2ou6vtPLHdB5SyPJ0BwOeUTdzwEzv2gpIvGLgQb0fy3xDCc2ZH/SAMieUMHRkfg5L7CBeRoK44xoM9Bp+vUMI9dVpN70srMFxPiw/buDku0YMjFI1hpHjFbLCuzRbqfO5+MBEAkiAYBB5IC1ZBbjOb9huZO6V6uNCHNTxviVVEkQCwFHXXSaavMI1TBdHXC8ZUhNIN2JDJaV3XEhpeYfGMa29qvlcaKqKMTpDNh1xpw3lLMmwmZRGHEwk1h1ZqtC3bvkWs9K1X1Ukauo4EbnvsjfnT+axwasqPSORjNaR3WfxQU28f2W+DNlKgYToSFo0NQBz2RP64nc/bsJ/VpnJ3HW6HnRpC2XDHDggNUY5Gsp0Uw0UUThqGuxFIiQ9Lj1IutAaKnewt7nkPIN5jOGwaUn1usF/Qa2evELLiBcoiNUDkPqCT9kt1byFF3FkS4esEGGooS+0WIN/IAikmpZ5jKu7ousQxvgdCnTccI9UACfFuHJTBc24EMIvzwh5EuG++Yzl5doeyx/2MR6alJPF9lyUfcHQvNIMZytsM1Zyh/o5ZKwi6xypspV8wlDTDGYAHY08EENLi/Hig+ci9Ufd2vfaq4buy3DUxzh/xFAsO1bit7psNMKfo06PZI/z/ZzUQgqbDSkYoA5HVkmdJmMXrnUsybtj8FGP0M03UURPKFXfiarDLSYSmCtp81Gkrb6Hn6SxaevGTlDsOZX4WHYJXlRpgs2UQiM07sDzZOAQ+NMBeiZJxcHT7SKfR6vxPp+WMPK0WEP3Tq78A1pLJCB5qAlRsXBlRCyYiuf3aYn8oPbqH3BPRnqB9fKvf2SFpWcmaKUSf9uDEE+c70Mo8C6HDOCSCS0xI0dOVIuamq+ajGBzTATBgkqhkiG9w0BCRUxBgQEAQAAADBXBgkqhkiG9w0BCRQxSh5IADQAMgA4AGQAYwBlADgAOQAtADQANABlADAALQA0AGMAYwAyAC0AOABjADcAZAAtADAAYQA3ADIAZQAzADQANABiADUANgA1MF0GCSsGAQQBgjcRATFQHk4ATQBpAGMAcgBvAHMAbwBmAHQAIABTAHQAcgBvAG4AZwAgAEMAcgB5AHAAdABvAGcAcgBhAHAAaABpAGMAIABQAHIAbwB2AGkAZABlAHIwggM3BgkqhkiG9w0BBwagggMoMIIDJAIBADCCAx0GCSqGSIb3DQEHATAcBgoqhkiG9w0BDAEDMA4ECKxn/P9LAsDAgIH0ICCAvAi/Qp/EWYC8Y94wcojhnOYeisRNWDyKqe3tg9ZhD8mJf3ODzKxGl6hCKvB9Mio7qGDpY/24yLDyZtWCCEuLUE7lgSK+PQkfWX14ywWt/mwPOzVhLL9jQhjNjUy06NSMW49sY9iixGtI+o6HfAoALN5g/jg82J5qo4JFQJ0CxGGRLL2HaTy/FiduHjBfe9mBMvLNxmq+jxGXzEbTVvQsgG5IWdlWBoAu38KwJ6yxRULaexLP2+MjF954dk9EoXdTdqjXkQJiA24ukGR+6wIAeQqM5+K5OqlRAG5MP97qGBVpkVhDGcvvACximDj+RtNX3TnVn2S+YN0H6P6i7aRJsCGs9gCAdhU/Z7+4Xf+KxBfJc0DDcfNIMqDOtS1KiIICFCwynyQyh3MeOdfv1wFrLOa/ljk3vKgg1hEHRpqoPhFxb0w7BdBvDCpgDqN1iy8v1STOiWtNaVsv7taJ3idmGPPb47LEwFp/NOJS37IJCSdzM6Fs+GjqXWx7om7GZoboAxp9WGeaABErhrN9fdr9cO8k+7HpQLBPW0Ib344gZqfe81/s8mU9yxADpNUyC9AnPxPvl9rwpHpxj0rCpty1q4V3YEkQHOQRCUVM4E0COdff6wL6XOmWm/xS79TrNSZ0gpBOaFS1cnVehsDoTbm6T/ZNmIPOb6fNmO/8dXoI6ErynSvTmbEJvUG0ppVs1BOc0DTOVfgI3uepKGJFvwjBp5u98orUTA7MB8wBwYFKw4DAhoEFPwC63vxL1bk1CCHbaUcPz+MYRg2BBSQ54B8/ca1iKG3pbx/MnWo+YGZnQICB9A=",
"subscriptionIds": [ "ab7092ea-8fa4-4705-b607-89f3dd09babd" ] } |
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 the name of Azure AD application associated with Microsoft Azure service account. |
description | string | Specifies the description of Microsoft Azure service account. |
applicationId | string | Specifies the Azure AD application ID. |
applicationCertificateThumbprint | string | Specifies the application certificate thumbprint for connecting to Microsoft Azure. |
azureEnvironment | string | Specifies the Microsoft Azure region. The following values are available:
|
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. |
Response Example
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" } |
