This is an archive version of the document. To get the most up-to-date information, see the current version.Listing Subscriptions
This section explains how to get a list of Azure subscriptions.
Request
POST https://<hostname>/api/v1/accounts/imported/listSubscriptions |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
None.
Request Body
Property | Type | Description |
azureEnvironment | string | Sets the Azure environment. |
applicationId | string | Sets the identification number of the application. |
applicationPassword | string | Sets the password for the specified application. |
tenantId | string | Sets the identification number of the tenant. |
applicationCertificate | string | Sets the application certificate. |
certificatePassword | string | Sets the password for the application certificate. |
useType | string | Sets the user type. |
|
Make sure to use either applicationId or applicationCertificate. Using both parameters at the same time is not possible. |
Request Example
Request: POST https://<hostname>/api/v1/accounts/imported/listSubscriptions
Request Header: Authorization: Bearer <Access-Token>
Request Header: { "azureEnvironment": "Global", "applicationId": "79b0fe30-6b85-44c3-98df-39a748c1dfb1", "applicationPassword": "E.Z@aZc1w00]CZ-6--86U=r/k3lDgSfc", "tenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52", "useType": "Service" } |
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 contains the following information.
Property | Type | Description |
environment | string | Shows the environment of the subscription. |
defaultTenantId | string | Shows the default identification number of a tenant. |
subscriptions | Contains the Subscription object. | |
requiredRolesHint | string | Shows the requirements for permissions that must be given to the account the is being used. |
Property | Type | Description |
id | string | Shows the identification number of the Azure subscription. |
name | string | Shows the name of the Azure subscription. |
tenantId | string | Shows the identification number of the tenant. |
permissionsState | string | Shows the permissions state. |
missingPermissions | string | Shows a list of permissions that are missing. |
Response Example
Response: 200 OK
Response Body: { "environment": "Global", "defaultTenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52", "subscriptions": [ { "id": "3a9a8340-7bbc-4b03-9c68-11d674fbc809", "name": "Visual Studio Premium MSDN", "tenantId": "3e924b89-93bc-40d5-8d47-33f07b539a52", "permissionsState": "AvailableAll", "missingPermissions": [] }], "requiredRolesHint": ["Contributor"] } |