Skip to main content
Version: latest

Check if Azure account is valid

POST 
/v1/clouds/azure/account/validate

Returns no contents if account is valid else error.

Request​

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Body

required

Request payload for Azure cloud account

    azureEnvironmentstring

    Possible values: [AzureChinaCloud, AzurePublicCloud, AzureUSGovernment, AzureUSGovernmentCloud]

    Default value: AzurePublicCloud

    Contains configuration for Azure cloud

    clientIdstringrequired

    Client ID(Directory ID) is a unique identifier generated by Azure AD that is tied to an application

    clientSecretstringrequired

    ClientSecret is the secret associated with Client

    settings

    object

    Cloud account settings

    disablePropertiesRequestboolean

    Will disable certain properties request to cloud and the input is collected directly from the user

    tenantIdstringrequired

    Tenant ID is the ID for the Azure AD tenant that the user belongs to.

    tenantNamestring

    Tenant ID is the ID for the Azure AD tenant that the user belongs to.

Responses​

Ok response without content

Response Headers

  • AuditUid

    string

    Audit uid for the request

Loading...