---
updatedAt: 2025-09-16T00:22:08.000Z
agentTools:
  projectIndex: https://docs.cgn.portal.checkpoint.com/llms.txt
---

# Post

Add (onboard) an Azure account to the user's Dome9 account

# OpenAPI definition

```json
{
  "info": {
    "title": "Onboarding",
    "version": "v2"
  },
  "openapi": "3.0.0",
  "servers": [
    {
      "url": "https://api.dome9.com/",
      "description": "US region"
    },
    {
      "url": "https://api.{region}.dome9.com/",
      "description": "Other regions",
      "variables": {
        "region": {
          "enum": [
            "eu1",
            "ap1",
            "ap2",
            "ap3",
            "cace1"
          ],
          "default": "eu1"
        }
      }
    }
  ],
  "paths": {
    "/v2/AzureCloudAccount": {
      "post": {
        "tags": [
          "Azure Cloud Account"
        ],
        "summary": "Post",
        "operationId": "AzureCloudAccount_Post_post_/v2/AzureCloudAccount",
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Dome9.Web.Api.Models.AzureCloudAccountViewModel"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Dome9.Web.Api.Models.AzureCloudAccountViewModel"
              }
            },
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/Dome9.Web.Api.Models.AzureCloudAccountViewModel"
              }
            }
          },
          "description": "details for the Azure account",
          "required": true
        },
        "description": "Add (onboard) an Azure account to the user's Dome9 account"
      }
    }
  },
  "components": {
    "schemas": {
      "Dome9.Web.Api.Models.AzureCloudAccountViewModel": {
        "description": "account details",
        "required": [
          "subscriptionId",
          "tenantId",
          "credentials",
          "operationMode"
        ],
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "description": "account id in Dome9",
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000"
          },
          "name": {
            "description": "account name (in Dome9)",
            "type": "string"
          },
          "subscriptionId": {
            "description": "Azure subscription id",
            "type": "string"
          },
          "managementGroupId": {
            "description": "Azure management group id",
            "type": "string"
          },
          "tenantId": {
            "description": "Azure tenant id",
            "type": "string"
          },
          "credentials": {
            "$ref": "#/components/schemas/Dome9.Web.Api.Models.AzureAccountCredentialsViewModel",
            "description": "Azure account credentials"
          },
          "operationMode": {
            "description": "Dome9 operation mode for the Azure account (Read-Only or Managed)",
            "enum": [
              "Read",
              "Manage"
            ],
            "type": "string"
          },
          "error": {
            "description": "Error status for the account onboarding process to Dome9",
            "type": "string"
          },
          "creationDate": {
            "format": "date-time",
            "description": "date Azure account was onboarded to a Dome9 account",
            "type": "string"
          },
          "isMultiTenant": {
            "description": "Indicates whether the cloud account is managed under a multi-tenant account",
            "type": "boolean"
          },
          "organizationalUnitId": {
            "format": "uuid",
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000"
          },
          "organizationalUnitPath": {
            "type": "string"
          },
          "organizationalUnitName": {
            "type": "string"
          },
          "vendor": {
            "enum": [
              "aws",
              "hp",
              "mellanox",
              "awsgov",
              "azure",
              "google",
              "awschina",
              "azuregov",
              "kubernetes",
              "azurechina",
              "terraform",
              "generic",
              "kubernetesruntimeassurance",
              "shiftleft",
              "sourcecodeassurance",
              "imageassurance",
              "alibaba",
              "cft",
              "containerregistry",
              "oci",
              "ocigov",
              "ocigovuk",
              "CIEM"
            ],
            "type": "string"
          },
          "onboardingManagementMethod": {
            "enum": [
              "Undefined",
              "OrganizationOnboarding",
              "DetachedFromOrganizationOnboarding",
              "UnifiedOnboarding",
              "SimplifiedOnboarding",
              "ManualOnboarding"
            ],
            "type": "string"
          },
          "magellan": {
            "type": "boolean"
          },
          "missingPermissions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "Dome9.Web.Api.Models.AzureAccountCredentialsViewModel": {
        "required": [
          "clientId",
          "clientPassword"
        ],
        "type": "object",
        "properties": {
          "clientId": {
            "description": "Azure account id",
            "type": "string"
          },
          "clientPassword": {
            "description": "Password for account",
            "type": "string"
          }
        }
      }
    },
    "securitySchemes": {
      "basic": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basic": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```