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/AlibabaCloudAccount/{id}/DeleteForce: delete: tags: - Alibaba Cloud Account summary: Delete Force operationId: AlibabaCloudAccount_DeleteForceAsync_delete_/v2/AlibabaCloudAccount/{id}/DeleteForce parameters: - name: id in: path description: the Dome9 account id for the account or the Subscription id required: true schema: type: string format: uuid responses: '204': description: No Content description: Delete an Alibaba account from a Dome9 account (the Alibaba account is not deleted from Alibaba) and linked entities /v2/AlibabaCloudAccount/{cloudAccountId}/account-stats: get: tags: - Alibaba Cloud Account summary: Get Cloud Account Stats operationId: AlibabaCloudAccount_GetCloudAccountStatsAsync_get_/v2/AlibabaCloudAccount/{cloudAccountId}/account-stats parameters: - name: cloudAccountId in: path description: The Id of the Alibaba cloud account required: true schema: type: string format: uuid - name: withData in: query description: Include raw data of networks, security groups and vms, default = false required: false schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaAccountStatsViewModel' description: Gets Cloud Account network statistics on cloud account page /v2/AlibabaCloudAccount/MissingPermissions: get: tags: - Alibaba Cloud Account summary: Get Missing Permissions operationId: AlibabaCloudAccount_GetMissingPermissions_get_/v2/AlibabaCloudAccount/MissingPermissions responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.CloudAccountMissingPermissionsViewModel' description: Get a list of missing permissions (needed by Dome9 to manage the accounts) for all Alibaba accounts in Dome9 /v2/AlibabaCloudAccount/{id}/MissingPermissions: get: tags: - Alibaba Cloud Account summary: Get Missing Permissions operationId: AlibabaCloudAccount_GetMissingPermissionsAsync_get_/v2/AlibabaCloudAccount/{id}/MissingPermissions parameters: - name: id in: path description: '' required: true schema: type: string format: uuid - name: showIgnored in: query description: '' required: false schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.CloudAccountMissingPermissionsIgnorableViewModel' description: Get a list of missing permissions for a specific account. These permissions are needed by Dome9 to manage accounts. put: tags: - Alibaba Cloud Account summary: Update Ignorable Missing Permissions operationId: AlibabaCloudAccount_UpdateIgnorableMissingPermissionsAsync_put_/v2/AlibabaCloudAccount/{id}/MissingPermissions parameters: - name: id in: path description: CloudAccountId required: true schema: type: string format: uuid responses: '204': description: No Content requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.MissingPermissionsIgnorableUpdateViewModel' application/x-www-form-urlencoded: schema: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.MissingPermissionsIgnorableUpdateViewModel' description: List of permissions to set ignore or restore flag to required: true description: Get a list of missing permissions for a specific account. These are permissions needed by Dome9 to manage accounts. /v2/AlibabaCloudAccount/{id}/MissingPermissions/EntityType: get: tags: - Alibaba Cloud Account summary: Get Missing Permissions By Entity Type operationId: AlibabaCloudAccount_GetMissingPermissionsByEntityTypeAsync_get_/v2/AlibabaCloudAccount/{id}/MissingPermissions/EntityType parameters: - name: id in: path description: The Dome9 Alibaba Cloud Account Id required: true schema: type: string format: uuid - name: entityType in: query description: The entity type for which to get permission issues required: true schema: type: string - name: subType in: query description: '' required: false schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.MissingPermissionViewModel' description: Get missing permissions for a specific entity type for a specific Alibaba Cloud account /v2/AlibabaCloudAccount/{id}/MissingPermissions/Reset: put: tags: - Alibaba Cloud Account summary: Reset Missing Permissions operationId: AlibabaCloudAccount_ResetMissingPermissionsAsync_put_/v2/AlibabaCloudAccount/{id}/MissingPermissions/Reset parameters: - name: id in: path description: the account id required: true schema: type: string format: uuid responses: '204': description: No Content description: "Reset (re-validate) a Alibaba Cloud account credentials in Dome9. \r\nWill cause all entities to retry\ \ fetching from the Alibaba cloud account." /v2/AlibabaCloudAccount/{id}/AccountName: put: tags: - Alibaba Cloud Account summary: Update Account Name operationId: AlibabaCloudAccount_UpdateAccountNameAsync_put_/v2/AlibabaCloudAccount/{id}/AccountName parameters: - name: id in: path description: the account id required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaCloudAccountGetViewModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaAccountNameViewModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaAccountNameViewModel' description: the updated name as it will appear in Dome9 required: true description: Update a Alibaba Cloud account name (as it appears in Dome9) /v2/AlibabaCloudAccount/{id}/Credentials: put: tags: - Alibaba Cloud Account operationId: AlibabaCloudAccount_UpdateAlibabaCloudAccountCredentialsAsync_put_/v2/AlibabaCloudAccount/{id}/Credentials parameters: - name: id in: path required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaCloudAccountGetViewModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaAccountCredentialsViewPostModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaAccountCredentialsViewPostModel' required: true description: '' summary: Update Alibaba Cloud Account Credentials /v2/AlibabaCloudAccount/{id}/SyncNow: post: tags: - Alibaba Cloud Account operationId: AlibabaCloudAccount_SyncNow_post_/v2/AlibabaCloudAccount/{id}/SyncNow parameters: - name: id in: path required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaCloudAccountGetViewModel' description: '' summary: Sync Now /v2/AlibabaCloudAccount/{id}/organizationalUnit: put: tags: - Alibaba Cloud Account summary: Update Organizational Id operationId: AlibabaCloudAccount_UpdateOrganizationalId_put_/v2/AlibabaCloudAccount/{id}/organizationalUnit parameters: - name: id in: path description: The Dome9 Guid ID of the Alibaba cloud account required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaCloudAccountGetViewModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel' description: The Guid ID of the Organizational Unit to attach to. Use 'null' to attach to the root Organizational Unit required: true description: "Update the ID of the Organizational Unit that this cloud account will be attached to.\r\nUse 'null' for\ \ the root organizational unit" /v2/AlibabaCloudAccount/organizationalUnit/move: put: tags: - Alibaba Cloud Account summary: Move Cloud Accounts To Organizational Unit operationId: AlibabaCloudAccount_MoveCloudAccountsToOrganizationalUnit_put_/v2/AlibabaCloudAccount/organizationalUnit/move responses: '200': description: OK content: application/json: schema: type: object requestBody: $ref: '#/components/requestBodies/Dome9.BL.Std.Services.OrganizationalUnit.MoveOrganizationalUnitViewModel' description: "Detach cloud accounts from an Organizational unit and attach them to another Organizational unit.\r\n\ Use 'null' for root organizational unit" /v2/AlibabaCloudAccount/organizationalUnit/moveAll: put: tags: - Alibaba Cloud Account summary: Move All Cloud Accounts To Organizational Unit operationId: AlibabaCloudAccount_MoveAllCloudAccountsToOrganizationalUnit_put_/v2/AlibabaCloudAccount/organizationalUnit/moveAll responses: '200': description: OK content: application/json: schema: type: object requestBody: $ref: '#/components/requestBodies/Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel2' description: Detach all cloud accounts from their current organizational unit and attach them to a new one. Default is to root organizational unit /v2/AlibabaCloudAccount/organizationalUnit/attach: post: tags: - Alibaba Cloud Account summary: Post Attach Multi operationId: AlibabaCloudAccount_PostAttachMulti_post_/v2/AlibabaCloudAccount/organizationalUnit/attach responses: '200': description: OK content: application/json: schema: type: object requestBody: $ref: '#/components/requestBodies/Dome9.BL.Std.Services.OrganizationalUnit.AttachCloudAccountsViewModel' description: Attach several cloud accounts to a specific Organizational Unit. User 'null' as root Organizational Unit as target /v2/AlibabaCloudAccount: get: tags: - Alibaba Cloud Account summary: Get operationId: AlibabaCloudAccount_Get_get_/v2/AlibabaCloudAccount responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaCloudAccountGetViewModel' description: Get a list of all Alibaba cloud accounts post: tags: - Alibaba Cloud Account summary: Post operationId: AlibabaCloudAccount_Post_post_/v2/AlibabaCloudAccount responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaCloudAccountGetViewModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaCloudAccountPostViewModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaCloudAccountPostViewModel' description: details for the new account required: true description: Add (onboard) a new Alibaba cloud account to Dome9 /v2/AlibabaCloudAccount/{id}: get: tags: - Alibaba Cloud Account summary: Get operationId: AlibabaCloudAccount_Get_get_/v2/AlibabaCloudAccount/{id} parameters: - name: id in: path description: the Alibaba cloud account id required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaCloudAccountGetViewModel' description: Get details for a specific Alibaba Cloud Account delete: tags: - Alibaba Cloud Account summary: Delete operationId: AlibabaCloudAccount_Delete_delete_/v2/AlibabaCloudAccount/{id} parameters: - name: id in: path description: the Dome9 account id for the account or the Subscription id required: true schema: type: string format: uuid responses: '204': description: No Content description: Delete an Alibaba account from a Dome9 account (the Alibaba account is not deleted from Alibaba) /v2/cloudaccounts/{id}/DeleteForce: delete: tags: - Aws Cloud Account summary: Delete Force operationId: CloudAccounts_DeleteForce_delete_/v2/cloudaccounts/{id}/DeleteForce parameters: - name: id in: path description: The Dome9 AWS account id (UUID) required: true schema: type: string format: uuid responses: '204': description: No Content description: Delete an AWS cloud account and linked entities. /v2/cloudaccounts/name: put: tags: - Aws Cloud Account summary: Update Cloud Account Name operationId: CloudAccounts_UpdateCloudAccountName_put_/v2/cloudaccounts/name responses: '200': description: OK content: application/json: schema: type: object requestBody: content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountPartialUpdateViewModel_System.String_' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountPartialUpdateViewModel_System.String_' description: the new name for the account required: true description: Update an AWS cloud account name. /v2/cloudaccounts/region-conf: put: tags: - Aws Cloud Account summary: Update Cloud Account Region Conf operationId: CloudAccounts_UpdateCloudAccountRegionConf_put_/v2/cloudaccounts/region-conf responses: '200': description: OK content: application/json: schema: type: object requestBody: content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountPartialUpdateViewModel_Dome9.Web.Api.Models.CloudAccountRegionConfigurationViewModel_' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountPartialUpdateViewModel_Dome9.Web.Api.Models.CloudAccountRegionConfigurationViewModel_' description: updated Regional Configuration parameters for the account required: true description: Update an AWS cloud account region configuration. /v2/cloudaccounts/credentials: put: tags: - Aws Cloud Account summary: Update Cloud Account Credentials operationId: CloudAccounts_UpdateCloudAccountCredentials_put_/v2/cloudaccounts/credentials responses: '200': description: OK content: application/json: schema: type: object requestBody: content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountPartialUpdateViewModel_Dome9.Web.Api.Models.CloudAccountCredentialsViewModel_' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountPartialUpdateViewModel_Dome9.Web.Api.Models.CloudAccountCredentialsViewModel_' description: credentials block required: true description: "Update credentials for an AWS cloud account in Dome9.\r\nAt least one of the following properties must\ \ be provided: \"cloudAccountId\", \"externalAccountNumber\"" /v2/cloudaccounts/MissingPermissions: get: tags: - Aws Cloud Account summary: Get Missing Permissions operationId: CloudAccounts_GetMissingPermissionsAsync_get_/v2/cloudaccounts/MissingPermissions responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.CloudAccountMissingPermissionsViewModel' description: Get a list of missing permissions for all accounts. These are permissions needed by Dome9 to manage accounts. /v2/cloudaccounts/{id}/MissingPermissions: get: tags: - Aws Cloud Account summary: Get Missing Permissions operationId: CloudAccounts_GetMissingPermissionsAsync_get_/v2/cloudaccounts/{id}/MissingPermissions parameters: - name: id in: path description: '' required: true schema: type: string format: uuid - name: showIgnored in: query description: '' required: false schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.CloudAccountMissingPermissionsIgnorableViewModel' description: Get a list of missing permissions for a specific account. These permissions are needed by Dome9 to manage accounts. put: tags: - Aws Cloud Account summary: Update Ignorable Missing Permissions operationId: CloudAccounts_UpdateIgnorableMissingPermissionsAsync_put_/v2/cloudaccounts/{id}/MissingPermissions parameters: - name: id in: path description: CloudAccountId required: true schema: type: string format: uuid responses: '204': description: No Content requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.MissingPermissionsIgnorableUpdateViewModel' application/x-www-form-urlencoded: schema: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.MissingPermissionsIgnorableUpdateViewModel' description: List of permissions to set ignore or restore flag to required: true description: Get a list of missing permissions for a specific account. These are permissions needed by Dome9 to manage accounts. /v2/cloudaccounts/{id}/MissingPermissions/EntityType: get: tags: - Aws Cloud Account summary: Get Missing Permissions By Entity Type operationId: CloudAccounts_GetMissingPermissionsByEntityTypeAsync_get_/v2/cloudaccounts/{id}/MissingPermissions/EntityType parameters: - name: id in: path description: The account id required: true schema: type: string format: uuid - name: entityType in: query description: The entity type required: true schema: type: string - name: subType in: query description: The entity subtype (optional) required: false schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.MissingPermissionViewModel' description: Get a list of missing permissions for a specific cloud entity type and cloud account /v2/cloudaccounts/{id}/CloudAccountHasAssumeRolePermissionIssue: get: tags: - Aws Cloud Account summary: Cloud Account Has Assume Role Permission Issue operationId: CloudAccounts_CloudAccountHasAssumeRolePermissionIssueAsync_get_/v2/cloudaccounts/{id}/CloudAccountHasAssumeRolePermissionIssue parameters: - name: id in: path description: The account id required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: type: boolean description: check if the cloud account's role has permission issues or was deleted /v2/cloudaccounts/{id}/MissingPermissions/Reset: put: tags: - Aws Cloud Account summary: Reset Missing Permissions operationId: CloudAccounts_ResetMissingPermissionsAsync_put_/v2/cloudaccounts/{id}/MissingPermissions/Reset parameters: - name: id in: path description: The account id required: true schema: type: string format: uuid responses: '204': description: No Content description: reset (re-validate) an account /v2/cloudaccounts/{id}/SyncNow: post: tags: - Aws Cloud Account summary: Sync Now operationId: CloudAccounts_SyncNow_post_/v2/cloudaccounts/{id}/SyncNow parameters: - name: id in: path description: The account id. required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Models.AwsSyncNowResultViewModel' description: "Send a data sync command to immediately fetch cloud account data into Dome9's system caches.\r\nThis API\ \ is used in conjunction with EntityFetchStatus API resource to query the fetch status.\r\nRead more and see a full\ \ example here: https://github.com/Dome9/Python_API_SDK/blob/master/implementation/runSyncAssessment.md" /v2/cloudaccounts/{id}/organizationalUnit: put: tags: - Aws Cloud Account summary: Update Organizational Id operationId: CloudAccounts_UpdateOrganizationalId_put_/v2/cloudaccounts/{id}/organizationalUnit parameters: - name: id in: path description: The Dome9 Guid ID of the AWS cloud account required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountViewModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel' description: The Guid ID of the Organizational Unit to attach to. Use 'null' to attach to the root Organizational Unit required: true description: "Update the ID of the Organizational Unit that this cloud account will be attached to.\r\nUse 'null' for\ \ the root Organizational Unit" /v2/cloudaccounts/organizationalUnit/move: put: tags: - Aws Cloud Account summary: Move Cloud Accounts To Organizational Unit operationId: CloudAccounts_MoveCloudAccountsToOrganizationalUnit_put_/v2/cloudaccounts/organizationalUnit/move responses: '200': description: OK content: application/json: schema: type: object requestBody: $ref: '#/components/requestBodies/Dome9.BL.Std.Services.OrganizationalUnit.MoveOrganizationalUnitViewModel2' description: "Detach cloud accounts from an Organizational unit and attach them to another Organizational unit\r\nUse\ \ 'null' for root organizational unit" /v2/cloudaccounts/organizationalUnit/moveAll: put: tags: - Aws Cloud Account summary: Move All Cloud Accounts To Organizational Unit operationId: CloudAccounts_MoveAllCloudAccountsToOrganizationalUnit_put_/v2/cloudaccounts/organizationalUnit/moveAll responses: '200': description: OK content: application/json: schema: type: object requestBody: $ref: '#/components/requestBodies/Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel2' description: Detach all cloud accounts from their current organizational unit and attach them to a new one. Default is to root organizational unit /v2/cloudaccounts/organizationalUnit/attach: post: tags: - Aws Cloud Account summary: Post Attach Multi operationId: CloudAccounts_PostAttachMulti_post_/v2/cloudaccounts/organizationalUnit/attach responses: '200': description: OK content: application/json: schema: type: object requestBody: $ref: '#/components/requestBodies/Dome9.BL.Std.Services.OrganizationalUnit.AttachCloudAccountsViewModel' description: Attach several cloud accounts to a specific Organizational Unit. User 'null' as root Organizational Unit as target /v2/CloudAccounts: get: tags: - Aws Cloud Account summary: Get operationId: CloudAccounts_Get_get_/v2/CloudAccounts responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountViewModel' description: Get all AWS cloud accounts post: tags: - Aws Cloud Account summary: Post operationId: CloudAccounts_Post_post_/v2/CloudAccounts responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountViewModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountViewModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountViewModel' description: The new AWS account data required: true description: "Add a new AWS cloud account to CloudGuard
\r\nOnboarding an AWS cloud account manually (legacy method)\ \ requires CloudGuard to obtain permissions to access the account.
\r\nFor more information, see the procedure\ \ on the onboarding with API on the Secure Knowledge center:
How to onboard an AWS account to CloudGuard using the REST API" /v2/CloudAccounts/{id}: get: tags: - Aws Cloud Account summary: Get operationId: CloudAccounts_Get_get_/v2/CloudAccounts/{id} parameters: - name: id in: path description: The Dome9 AWS account id (UUID) or the AWS external account number (12 digit number) required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountViewModel' description: Fetch a specific AWS cloud account delete: tags: - Aws Cloud Account summary: Delete operationId: CloudAccounts_Delete_delete_/v2/CloudAccounts/{id} parameters: - name: id in: path description: The Dome9 AWS account id (UUID) required: true schema: type: string format: uuid responses: '204': description: No Content description: Delete an AWS cloud account. /v2/AwsUnifiedOnboarding/StackConfig: post: tags: - Aws Unified Onboarding summary: Get Stack Config operationId: AwsUnifiedOnboarding_GetStackConfig_post_/v2/AwsUnifiedOnboarding/StackConfig responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Onboarding.ViewModel.AwsStackConfigViewModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Onboarding.Requests.OnboardingConfigurationRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.Web.Api.Onboarding.Requests.OnboardingConfigurationRequest' required: true description: Returns the configuration should be set to the AWS cloud formation SDK for creating the Stack for the onboarding /v2/AwsUnifiedOnboarding/UpdateVersion/StackConfig/{onboardingId}: get: tags: - Aws Unified Onboarding summary: Get Update Stack Config operationId: AwsUnifiedOnboarding_GetUpdateStackConfig_get_/v2/AwsUnifiedOnboarding/UpdateVersion/StackConfig/{onboardingId} parameters: - name: onboardingId in: path description: the OnboardingId required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Onboarding.ViewModel.AwsStackConfigViewModel' description: Returns the configuration should be set to the AWS cloud formation SDK for an update /v2/AwsUnifiedOnboarding/{id}: get: tags: - Aws Unified Onboarding summary: Get operationId: AwsUnifiedOnboarding_Get_get_/v2/AwsUnifiedOnboarding/{id} parameters: - name: id in: path description: '' required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Onboarding.ViewModel.OnboardingInfoViewModel' description: Gets the Onboarding information /v2/AzureCloudAccount/{id}/DeleteForce: delete: tags: - Azure Cloud Account summary: Delete Force operationId: AzureCloudAccount_DeleteForce_delete_/v2/AzureCloudAccount/{id}/DeleteForce parameters: - name: id in: path description: the Dome9 account id for the account or the Subscription id required: true schema: type: string format: uuid responses: '204': description: No Content description: Delete an Azure account from a Dome9 account (the Azure account is not deleted from Azure) and linked entities /v2/AzureCloudAccount/OnboardingExecutionPreview: get: tags: - Azure Cloud Account summary: Get Onboarding Script For Preview operationId: AzureCloudAccount_GetOnboardingScriptForPreviewAsync_get_/v2/AzureCloudAccount/OnboardingExecutionPreview responses: '200': description: OK description: Get the script that performs Azure account onboarding /v2/AzureCloudAccount/OnboardingExecutionCommand: post: tags: - Azure Cloud Account summary: Generate Onboarding Execution Command operationId: AzureCloudAccount_GenerateOnboardingExecutionCommand_post_/v2/AzureCloudAccount/OnboardingExecutionCommand responses: '200': description: OK requestBody: content: application/json: schema: $ref: '#/components/schemas/CGN.Common.Model.CloudAccounts.Onboarding.AzureSimplifiedOnboardingExecCmdRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CGN.Common.Model.CloudAccounts.Onboarding.AzureSimplifiedOnboardingExecCmdRequest' required: true description: "Get the cloud account command line execution for Azure shell\r\nDetails for\ \ Azure cloud account." /v2/AzureCloudAccount/MissingPermissions: get: tags: - Azure Cloud Account summary: Get Missing Permissions operationId: AzureCloudAccount_GetMissingPermissions_get_/v2/AzureCloudAccount/MissingPermissions responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.CloudAccountMissingPermissionsViewModel' description: Get a list of missing permissions (required by Dome9) for all Azure accounts in a Dome9 account /v2/AzureCloudAccount/{id}/MissingPermissions: get: tags: - Azure Cloud Account summary: Get Missing Permissions operationId: AzureCloudAccount_GetMissingPermissionsAsync_get_/v2/AzureCloudAccount/{id}/MissingPermissions parameters: - name: id in: path description: '' required: true schema: type: string format: uuid - name: showIgnored in: query description: '' required: false schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.CloudAccountMissingPermissionsIgnorableViewModel' description: Get a list of missing permissions for a specific account. These permissions are needed by Dome9 to manage accounts. put: tags: - Azure Cloud Account summary: Update Ignorable Missing Permissions operationId: AzureCloudAccount_UpdateIgnorableMissingPermissionsAsync_put_/v2/AzureCloudAccount/{id}/MissingPermissions parameters: - name: id in: path description: CloudAccountId required: true schema: type: string format: uuid responses: '204': description: No Content requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.MissingPermissionsIgnorableUpdateViewModel' application/x-www-form-urlencoded: schema: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.MissingPermissionsIgnorableUpdateViewModel' description: List of permissions to set ignore or restore flag to required: true description: Get a list of missing permissions for a specific account. These are permissions needed by Dome9 to manage accounts. /v2/AzureCloudAccount/{id}/MissingPermissions/EntityType: get: tags: - Azure Cloud Account summary: Get Missing Permissions By Entity Type operationId: AzureCloudAccount_GetMissingPermissionsByEntityTypeAsync_get_/v2/AzureCloudAccount/{id}/MissingPermissions/EntityType parameters: - name: id in: path description: the account id for the Azure account in Dome9 required: true schema: type: string format: uuid - name: entityType in: query description: the entity type required: true schema: type: string - name: subType in: query description: the entity subtype required: false schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.MissingPermissionViewModel' description: Get a list of missing permissions for a specific cloud entity type and Azure cloud account /v2/AzureCloudAccount/{id}/MissingPermissions/Reset: put: tags: - Azure Cloud Account summary: Reset Missing Permissions operationId: AzureCloudAccount_ResetMissingPermissions_put_/v2/AzureCloudAccount/{id}/MissingPermissions/Reset parameters: - name: id in: path description: the account id for the Azure account in Dome9 required: true schema: type: string format: uuid responses: '204': description: No Content description: Reset (re-validate) the missing permissions indication for an Azure account in Dome9 /v2/AzureCloudAccount/{id}/OperationMode: put: tags: - Azure Cloud Account summary: Update Operation Mode operationId: AzureCloudAccount_UpdateOperationModeAsync_put_/v2/AzureCloudAccount/{id}/OperationMode parameters: - name: id in: path description: the account id for the Azure account in Dome9 required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Models.AzureCloudAccountViewModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Azure.Accounts.AzureAccountOperationModeViewModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.Web.Api.Azure.Accounts.AzureAccountOperationModeViewModel' description: updated details for the account, including the operations mode required: true description: Update the operations mode for an Azure account in Dome9. Modes can be Read-Only or Manage /v2/AzureCloudAccount/{id}/AccountName: put: tags: - Azure Cloud Account summary: Update Account Name operationId: AzureCloudAccount_UpdateAccountName_put_/v2/AzureCloudAccount/{id}/AccountName parameters: - name: id in: path description: the account id in Dome9 required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Models.AzureCloudAccountViewModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Azure.Accounts.AzureAccountNameModeViewModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.Web.Api.Azure.Accounts.AzureAccountNameModeViewModel' description: the new name for the account required: true description: Update the account name (in Dome9) for an Azure account /v2/AzureCloudAccount/{id}/Credentials: put: tags: - Azure Cloud Account operationId: AzureCloudAccount_UpdateCloudAccountCredentials_put_/v2/AzureCloudAccount/{id}/Credentials parameters: - name: id in: path required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: type: object requestBody: content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Azure.Accounts.AzureCloudAccountCredentialsPutViewModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.Web.Api.Azure.Accounts.AzureCloudAccountCredentialsPutViewModel' required: true description: '' summary: Update Cloud Account Credentials /v2/AzureCloudAccount/{id}/SyncNow: post: tags: - Azure Cloud Account operationId: AzureCloudAccount_SyncNow_post_/v2/AzureCloudAccount/{id}/SyncNow parameters: - name: id in: path required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Models.AzureCloudAccountViewModel' description: '' summary: Sync Now /v2/AzureCloudAccount/{id}/CredentialsServicePrincipalId: get: tags: - Azure Cloud Account operationId: AzureCloudAccount_GetCredentialsServicePrincipalIdAsync_get_/v2/AzureCloudAccount/{id}/CredentialsServicePrincipalId parameters: - name: id in: path required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: type: string description: '' summary: Get Credentials Service Principal Id /v2/AzureCloudAccount/{id}/organizationalUnit: put: tags: - Azure Cloud Account summary: Update Organizational Id operationId: AzureCloudAccount_UpdateOrganizationalId_put_/v2/AzureCloudAccount/{id}/organizationalUnit parameters: - name: id in: path description: The Dome9 Guid ID of the Azure cloud account required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Models.AzureCloudAccountViewModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel' description: The Guid ID of the Organizational Unit to attach to. Use 'null' to attach to the root Organizational Unit required: true description: "Update the ID of the Organizational Unit that this cloud account will be attached to.\r\nUse 'null' for\ \ the root organizational unit" /v2/AzureCloudAccount/organizationalUnit/move: put: tags: - Azure Cloud Account summary: Move Cloud Accounts To Organizational Unit operationId: AzureCloudAccount_MoveCloudAccountsToOrganizationalUnit_put_/v2/AzureCloudAccount/organizationalUnit/move responses: '200': description: OK content: application/json: schema: type: object requestBody: $ref: '#/components/requestBodies/Dome9.BL.Std.Services.OrganizationalUnit.MoveOrganizationalUnitViewModel' description: "Detach cloud accounts from an Organizational unit and attach them to another Organizational unit.\r\n\ Use 'null' for root organizational unit" /v2/AzureCloudAccount/organizationalUnit/moveAll: put: tags: - Azure Cloud Account summary: Move All Cloud Accounts To Organizational Unit operationId: AzureCloudAccount_MoveAllCloudAccountsToOrganizationalUnit_put_/v2/AzureCloudAccount/organizationalUnit/moveAll responses: '200': description: OK content: application/json: schema: type: object requestBody: $ref: '#/components/requestBodies/Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel2' description: Detach all cloud accounts from their current organizational unit and attach them to a new one. Default is to root organizational unit /v2/AzureCloudAccount/organizationalUnit/attach: post: tags: - Azure Cloud Account summary: Post Attach Multi operationId: AzureCloudAccount_PostAttachMulti_post_/v2/AzureCloudAccount/organizationalUnit/attach responses: '200': description: OK content: application/json: schema: type: object requestBody: $ref: '#/components/requestBodies/Dome9.BL.Std.Services.OrganizationalUnit.AttachCloudAccountsViewModel' description: Attach several cloud accounts to a specific Organizational Unit. User 'null' as root Organizational Unit as target /v2/AzureCloudAccount/{id}: get: tags: - Azure Cloud Account summary: Get operationId: AzureCloudAccount_Get_get_/v2/AzureCloudAccount/{id} parameters: - name: id in: path description: the Dome9 account id for the Azure account required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Models.AzureCloudAccountViewModel' description: Get details for a specific Azure account delete: tags: - Azure Cloud Account summary: Delete operationId: AzureCloudAccount_Delete_delete_/v2/AzureCloudAccount/{id} parameters: - name: id in: path description: the Dome9 account id for the account or the Subscription id required: true schema: type: string format: uuid responses: '204': description: No Content description: Delete an Azure account from a Dome9 account (the Azure account is not deleted from Azure) /v2/AzureCloudAccount: get: tags: - Azure Cloud Account summary: Get operationId: AzureCloudAccount_Get_get_/v2/AzureCloudAccount responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Models.AzureCloudAccountViewModel' description: Get details for all Azure accounts for the Dome9 user 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 /v2/GoogleCloudAccount/{id}/DeleteForce: delete: tags: - Google Cloud Account summary: Delete Force operationId: GoogleCloudAccount_DeleteForce_delete_/v2/GoogleCloudAccount/{id}/DeleteForce parameters: - name: id in: path description: The Id of the Google cloud account required: true schema: type: string format: uuid responses: '204': description: No Content description: Delete a Google cloud account (from Dome9) and linked entities /v2/GoogleCloudAccount/{id}/DeleteGsuite: put: tags: - Google Cloud Account summary: Delete Gsuite operationId: GoogleCloudAccount_DeleteGsuite_put_/v2/GoogleCloudAccount/{id}/DeleteGsuite parameters: - name: id in: path description: The Id of the Google cloud account required: true schema: type: string format: uuid responses: '204': description: No Content description: Delete a Google cloud Gsuite account Only /v2/GoogleCloudAccount/{id}/details: get: tags: - Google Cloud Account operationId: GoogleCloudAccount_GetCloudAccountDetailsAsync_get_/v2/GoogleCloudAccount/{id}/details parameters: - name: id in: path required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Google.Accounts.GoogleAccountOnboardingDetailsViewModel' description: '' summary: Get Cloud Account Details /v2/GoogleCloudAccount/{cloudAccountId}/account-stats: get: tags: - Google Cloud Account summary: Get Cloud Account Stats operationId: GoogleCloudAccount_GetCloudAccountStats_get_/v2/GoogleCloudAccount/{cloudAccountId}/account-stats parameters: - name: cloudAccountId in: path description: The Id of the Google cloud account required: true schema: type: string format: uuid - name: withData in: query description: Include raw data of networks, security groups and vms, default = false required: false schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Google.Accounts.GoogleAccountStatsViewModel' description: Gets Cloud Account network statistics on cloud account page /v2/GoogleCloudAccount/MissingPermissions: get: tags: - Google Cloud Account summary: Get Missing Permissions operationId: GoogleCloudAccount_GetMissingPermissions_get_/v2/GoogleCloudAccount/MissingPermissions responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.CloudAccountMissingPermissionsViewModel' description: Get a list of missing permissions (needed by Dome9 to manage the accounts) for all Google accounts in Dome9 /v2/GoogleCloudAccount/{id}/MissingPermissions: get: tags: - Google Cloud Account summary: Get Missing Permissions operationId: GoogleCloudAccount_GetMissingPermissionsAsync_get_/v2/GoogleCloudAccount/{id}/MissingPermissions parameters: - name: id in: path description: '' required: true schema: type: string format: uuid - name: showIgnored in: query description: '' required: false schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.CloudAccountMissingPermissionsIgnorableViewModel' description: Get a list of missing permissions for a specific account. These permissions needed by Dome9 to manage accounts. put: tags: - Google Cloud Account summary: Update Ignorable Missing Permissions operationId: GoogleCloudAccount_UpdateIgnorableMissingPermissionsAsync_put_/v2/GoogleCloudAccount/{id}/MissingPermissions parameters: - name: id in: path description: CloudAccountId required: true schema: type: string format: uuid responses: '204': description: No Content requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.MissingPermissionsIgnorableUpdateViewModel' application/x-www-form-urlencoded: schema: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.MissingPermissionsIgnorableUpdateViewModel' description: List of permissions to set ignore or restore flag to required: true description: Get a list of missing permissions for a specific account. These are permissions needed by Dome9 to manage accounts. /v2/GoogleCloudAccount/{id}/MissingPermissions/EntityType: get: tags: - Google Cloud Account summary: Get Missing Permissions By Entity Type operationId: GoogleCloudAccount_GetMissingPermissionsByEntityTypeAsync_get_/v2/GoogleCloudAccount/{id}/MissingPermissions/EntityType parameters: - name: id in: path description: The Dome9 Google Cloud Account Id required: true schema: type: string format: uuid - name: entityType in: query description: The entity type for which to get permission issues required: true schema: type: string - name: subType in: query description: '' required: false schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.MissingPermissionViewModel' description: Get missing permissions for a specific entity type for a specific Google Cloud account /v2/GoogleCloudAccount/{id}/MissingPermissions/Reset: put: tags: - Google Cloud Account summary: Reset Missing Permissions operationId: GoogleCloudAccount_ResetMissingPermissionsAsync_put_/v2/GoogleCloudAccount/{id}/MissingPermissions/Reset parameters: - name: id in: path description: the account id required: true schema: type: string format: uuid responses: '204': description: No Content description: "Reset (re-validate) a Google Cloud account credentials in Dome9. \r\nWill cause all entities to retry\ \ fetching from the Google cloud account." /v2/GoogleCloudAccount/{id}/AccountName: put: tags: - Google Cloud Account summary: Update Account Name operationId: GoogleCloudAccount_UpdateAccountName_put_/v2/GoogleCloudAccount/{id}/AccountName parameters: - name: id in: path description: the account id required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Google.Accounts.GoogleCloudAccountGetViewModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Google.Accounts.GoogleAccountNameViewModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.Web.Api.Google.Accounts.GoogleAccountNameViewModel' description: the updated name as it will appear in Dome9 required: true description: Update a Google Cloud account name (as it appears in Dome9) /v2/GoogleCloudAccount/{id}/Credentials/Gsuite: put: tags: - Google Cloud Account summary: Update Account Gsuite operationId: GoogleCloudAccount_UpdateAccountGsuite_put_/v2/GoogleCloudAccount/{id}/Credentials/Gsuite parameters: - name: id in: path description: the account id required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Google.Accounts.GoogleCloudAccountGetViewModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Google.Accounts.GoogleAccountGsuiteViewModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.Web.Api.Google.Accounts.GoogleAccountGsuiteViewModel' description: the updated Gsuite as it will uses in Dome9 required: true description: Update a Google Cloud account Gsuite data /v2/GoogleCloudAccount/{id}/Credentials: put: tags: - Google Cloud Account operationId: GoogleCloudAccount_UpdateGoogleCloudAccountCredentials_put_/v2/GoogleCloudAccount/{id}/Credentials parameters: - name: id in: path required: true schema: type: string format: uuid - name: skipComputeValidation in: query required: false schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Google.Accounts.GoogleCloudAccountGetViewModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Google.Accounts.GoogleCloudAccountUpdateViewModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.Web.Api.Google.Accounts.GoogleCloudAccountUpdateViewModel' required: true description: '' summary: Update Google Cloud Account Credentials /v2/GoogleCloudAccount/{id}/SyncNow: post: tags: - Google Cloud Account operationId: GoogleCloudAccount_SyncNow_post_/v2/GoogleCloudAccount/{id}/SyncNow parameters: - name: id in: path required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Google.Accounts.GoogleCloudAccountGetViewModel' description: '' summary: Sync Now /v2/GoogleCloudAccount/{id}/organizationalUnit: put: tags: - Google Cloud Account summary: Update Organizational Id operationId: GoogleCloudAccount_UpdateOrganizationalId_put_/v2/GoogleCloudAccount/{id}/organizationalUnit parameters: - name: id in: path description: The Dome9 Guid ID of the GCP cloud account required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Google.Accounts.GoogleCloudAccountGetViewModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel' description: The Guid ID of the Organizational Unit to attach to. Use 'null' to attach to the root Organizational Unit required: true description: "Update the ID of the Organizational Unit that this cloud account will be attached to.\r\nUse 'null' for\ \ the root Organizational Unit" /v2/GoogleCloudAccount/organizationalUnit/move: put: tags: - Google Cloud Account summary: Move Cloud Accounts To Organizational Unit operationId: GoogleCloudAccount_MoveCloudAccountsToOrganizationalUnit_put_/v2/GoogleCloudAccount/organizationalUnit/move responses: '200': description: OK content: application/json: schema: type: object requestBody: $ref: '#/components/requestBodies/Dome9.BL.Std.Services.OrganizationalUnit.MoveOrganizationalUnitViewModel2' description: "Detach cloud accounts from an Organizational unit and attach them to another Organizational unit\r\nUse\ \ 'null' for root organizational unit" /v2/GoogleCloudAccount/organizationalUnit/moveAll: put: tags: - Google Cloud Account summary: Move All Cloud Accounts To Organizational Unit operationId: GoogleCloudAccount_MoveAllCloudAccountsToOrganizationalUnit_put_/v2/GoogleCloudAccount/organizationalUnit/moveAll responses: '200': description: OK content: application/json: schema: type: object requestBody: $ref: '#/components/requestBodies/Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel2' description: Detach all cloud accounts from their current organizational unit and attach them to a new one. Default is to root organizational unit /v2/GoogleCloudAccount/organizationalUnit/attach: post: tags: - Google Cloud Account summary: Post Attach Multi operationId: GoogleCloudAccount_PostAttachMulti_post_/v2/GoogleCloudAccount/organizationalUnit/attach responses: '200': description: OK content: application/json: schema: type: object requestBody: $ref: '#/components/requestBodies/Dome9.BL.Std.Services.OrganizationalUnit.AttachCloudAccountsViewModel' description: Attach several cloud accounts to a specific Organizational Unit. User 'null' as root Organizational Unit as target /v2/GoogleCloudAccount: get: tags: - Google Cloud Account summary: Get operationId: GoogleCloudAccount_Get_get_/v2/GoogleCloudAccount responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Google.Accounts.GoogleCloudAccountGetViewModel' description: Get a list of all Google cloud accounts post: tags: - Google Cloud Account summary: Post operationId: GoogleCloudAccount_Post_post_/v2/GoogleCloudAccount parameters: - name: skipComputeValidation in: query description: is ondoarding without compute Api enabled required: false schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Google.Accounts.GoogleCloudAccountGetViewModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Google.Accounts.GoogleCloudAccountPostViewModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.Web.Api.Google.Accounts.GoogleCloudAccountPostViewModel' description: details for the new account required: true description: Add (onboard) a new Google cloud account to Dome9 /v2/GoogleCloudAccount/{id}: get: tags: - Google Cloud Account summary: Get operationId: GoogleCloudAccount_Get_get_/v2/GoogleCloudAccount/{id} parameters: - name: id in: path description: the Google cloud account id required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Dome9.Web.Api.Google.Accounts.GoogleCloudAccountGetViewModel' description: Get details for a specific Google Cloud Account delete: tags: - Google Cloud Account summary: Delete operationId: GoogleCloudAccount_Delete_delete_/v2/GoogleCloudAccount/{id} parameters: - name: id in: path description: The Id of the Google cloud account required: true schema: type: string format: uuid responses: '204': description: No Content description: Delete a Google cloud account (from Dome9) /v2/kubernetes/account: get: tags: - Kubernetes Account summary: Get All operationId: KubernetesAccount_GetAll_get_/v2/kubernetes/account responses: '200': description: A list of Kubernetes accounts content: application/json: schema: type: array items: $ref: '#/components/schemas/KubernetesAccountViewModel' example: - id: afc490f9-f9ff-4414-83ed-44885f2f4468 externalAccountNumber: afc490f9-f9ff-4414-83ed-44885f2f4468 threatIntelligenceEnabled: false imageAssuranceEnabled: false imageAccessRuntimeMonitorEnabled: false runtimeProtectionEnabled: false runtimeProtectionNetwork: false runtimeProtectionProfiling: false runtimeProtectionFileReputation: false admissionControlEnabled: false admissionControlFailOpen: true name: '' creationDate: '0001-01-01T00:00:00' vendor: kubernetes organizationalUnitId: null organizationalUnitPath: '' organizationalUnitName: '' clusterVersion: null clusterVersionStatus: Unknown clusterVersionStatusDescription: '' description: null platform: kubernetes type: 0 description: Get a list of all Kubernetes accounts post: tags: - Kubernetes Account summary: Post operationId: KubernetesAccount_Post_post_/v2/kubernetes/account requestBody: x-name: model description: 'KubernetesGetViewModel that has three paramaters, Name(string), Description(string) and OrgorganizationalUnitId(Guid) ' content: application/json: schema: $ref: '#/components/schemas/KubernetesPostViewModel' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/KubernetesAccountViewModel' example: id: afc490f9-f9ff-4414-83ed-44885f2f4468 externalAccountNumber: afc490f9-f9ff-4414-83ed-44885f2f4468 threatIntelligenceEnabled: false imageAssuranceEnabled: false imageAccessRuntimeMonitorEnabled: false runtimeProtectionEnabled: false runtimeProtectionNetwork: false runtimeProtectionProfiling: false runtimeProtectionFileReputation: false admissionControlEnabled: false admissionControlFailOpen: true name: '' creationDate: '0001-01-01T00:00:00' vendor: kubernetes organizationalUnitId: null organizationalUnitPath: '' organizationalUnitName: '' clusterVersion: null clusterVersionStatus: Unknown clusterVersionStatusDescription: '' description: null platform: kubernetes type: 0 description: Add (onboard) a new Kubernetes account to CloudGuard /v2/kubernetes/account/{id}: get: tags: - Kubernetes Account summary: Get operationId: KubernetesAccount_Get_get_/v2/kubernetes/account/{id} parameters: - name: id in: path required: true description: the Kubernetes account id schema: type: string format: guid x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/KubernetesAccountViewModel' example: id: afc490f9-f9ff-4414-83ed-44885f2f4468 externalAccountNumber: afc490f9-f9ff-4414-83ed-44885f2f4468 threatIntelligenceEnabled: false imageAssuranceEnabled: false imageAccessRuntimeMonitorEnabled: false runtimeProtectionEnabled: false runtimeProtectionNetwork: false runtimeProtectionProfiling: false runtimeProtectionFileReputation: false admissionControlEnabled: false admissionControlFailOpen: true name: '' creationDate: '0001-01-01T00:00:00' vendor: kubernetes organizationalUnitId: null organizationalUnitPath: '' organizationalUnitName: '' clusterVersion: null clusterVersionStatus: Unknown clusterVersionStatusDescription: '' description: null platform: kubernetes type: 0 description: Get details for a specific Kubernetes Account delete: tags: - Kubernetes Account summary: Delete operationId: KubernetesAccount_Delete_delete_/v2/kubernetes/account/{id} parameters: - name: id in: path required: true description: The Id of the Kubernetes account schema: type: string format: guid x-position: 1 responses: '200': description: '' description: Delete a Kubernetes account (from CloudGuard) /v2/kubernetes/account/{id}/accountName: put: tags: - Kubernetes Account summary: Update Account Name operationId: KubernetesAccount_UpdateAccountName_put_/v2/kubernetes/account/{id}/accountName parameters: - name: id in: path required: true description: the Kubernetes account id schema: type: string format: guid x-position: 1 - name: name in: query description: the updated name as it will appear in CloudGuard schema: type: string maxLength: 500 pattern: ^[\p{L}\p{M}0-9\s\-_'.,#/@;:!=]*$ x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/KubernetesAccountViewModel' example: id: afc490f9-f9ff-4414-83ed-44885f2f4468 externalAccountNumber: afc490f9-f9ff-4414-83ed-44885f2f4468 threatIntelligenceEnabled: false imageAssuranceEnabled: false imageAccessRuntimeMonitorEnabled: false runtimeProtectionEnabled: false runtimeProtectionNetwork: false runtimeProtectionProfiling: false runtimeProtectionFileReputation: false admissionControlEnabled: false admissionControlFailOpen: true name: '' creationDate: '0001-01-01T00:00:00' vendor: kubernetes organizationalUnitId: null organizationalUnitPath: '' organizationalUnitName: '' clusterVersion: null clusterVersionStatus: Unknown clusterVersionStatusDescription: '' description: null platform: kubernetes type: 0 description: Update a Kubernetes account name (as it appears in CloudGuard) /v2/kubernetes/account/{id}/accountDescription: put: tags: - Kubernetes Account summary: Update Account Description operationId: KubernetesAccount_UpdateAccountDescription_put_/v2/kubernetes/account/{id}/accountDescription parameters: - name: id in: path required: true description: the Kubernetes account id schema: type: string format: guid x-position: 1 - name: description in: query description: the updated description as it will appear in CloudGuard schema: type: string maxLength: 1000 pattern: ^[\p{L}\p{M}0-9\s\-_'.,#/@;:!=]*$ nullable: true x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/KubernetesAccountViewModel' example: id: afc490f9-f9ff-4414-83ed-44885f2f4468 externalAccountNumber: afc490f9-f9ff-4414-83ed-44885f2f4468 threatIntelligenceEnabled: false imageAssuranceEnabled: false imageAccessRuntimeMonitorEnabled: false runtimeProtectionEnabled: false runtimeProtectionNetwork: false runtimeProtectionProfiling: false runtimeProtectionFileReputation: false admissionControlEnabled: false admissionControlFailOpen: true name: '' creationDate: '0001-01-01T00:00:00' vendor: kubernetes organizationalUnitId: null organizationalUnitPath: '' organizationalUnitName: '' clusterVersion: null clusterVersionStatus: Unknown clusterVersionStatusDescription: '' description: null platform: kubernetes type: 0 description: Update a Kubernetes account description (as it appears in CloudGuard) /v2/kubernetes/account/{id}/imageAssurance/enable: post: tags: - Kubernetes Account summary: Enable Image Assurance operationId: KubernetesAccount_EnableImageAssurance_post_/v2/kubernetes/account/{id}/imageAssurance/enable parameters: - name: id in: path required: true description: the Kubernetes account id schema: type: string format: guid x-position: 1 responses: '200': description: '' description: Enable Image Assurance feature for Kubernetes (cluster) account /v2/kubernetes/account/{id}/imageAssurance/disable: post: tags: - Kubernetes Account summary: Disable Image Assurance operationId: KubernetesAccount_DisableImageAssurance_post_/v2/kubernetes/account/{id}/imageAssurance/disable parameters: - name: id in: path required: true description: the Kubernetes account id schema: type: string format: guid x-position: 1 responses: '200': description: '' description: Disable Image Assurance feature for Kubernetes (cluster) account /v2/kubernetes/account/{id}/runtimeProtection/enable: post: tags: - Kubernetes Account summary: Enable Runtime Protection operationId: KubernetesAccount_EnableRuntimeProtection_post_/v2/kubernetes/account/{id}/runtimeProtection/enable parameters: - name: id in: path required: true description: the Kubernetes account id schema: type: string format: guid x-position: 1 responses: '200': description: '' description: Enable Runtime Protection for Kubernetes account /v2/kubernetes/account/{id}/admissionControl/enable: post: tags: - Kubernetes Account summary: Enable Admission Control operationId: KubernetesAccount_EnableAdmissionControl_post_/v2/kubernetes/account/{id}/admissionControl/enable parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 responses: '200': description: '' description: Enable Admission Control for Kubernetes account /v2/kubernetes/account/{id}/admissionControl/disable: post: tags: - Kubernetes Account summary: Disable Admission Control operationId: KubernetesAccount_DisableAdmissionControl_post_/v2/kubernetes/account/{id}/admissionControl/disable parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 responses: '200': description: '' description: Disable Admission Control for Kubernetes account /v2/kubernetes/account/{id}/accountSummary: get: tags: - Kubernetes Account summary: Get Account Summary operationId: KubernetesAccount_GetAccountSummary_get_/v2/kubernetes/account/{id}/accountSummary parameters: - name: id in: path required: true description: the Kubernetes account id schema: type: string format: guid x-position: 1 responses: '200': description: KubernetesAccountSummaryViewModel content: application/json: schema: $ref: '#/components/schemas/KubernetesAccountSummaryViewModel' description: Get Kubernetes account summary data /v2/kubernetes/account/accountAgentStatus: get: tags: - Kubernetes Account summary: Get Account Agent Status operationId: KubernetesAccount_GetAccountAgentStatus_get_/v2/kubernetes/account/accountAgentStatus responses: '200': description: List of KubernetesAccountAgentStatusViewModel content: application/json: schema: type: array items: $ref: '#/components/schemas/KubernetesAccountAgentStatusViewModel' description: Get Kubernetes account agent status /v2/kubernetes/account/agentStatusReportCSV: post: tags: - Kubernetes Account summary: Get Csv Account Agent Status operationId: KubernetesAccount_GetCsvAccountAgentStatus_post_/v2/kubernetes/account/agentStatusReportCSV requestBody: x-name: filtersReq content: application/json: schema: $ref: '#/components/schemas/KubernetesAccountAgentStatusFiltersViewModel' required: true x-position: 1 responses: '200': description: 'CSV table with the following data for each agent: "Cluster Id", "Cluster Name", "Organizational Unit Id", "Organizational Unit Path", "Agent Type", "Node Name", "Version", "Status", "Description", "Last Communication", "Is Agent Up To Date"' content: application/octet-stream: schema: type: string format: binary description: Get a CSV table that provides the status of all agents in the Kubernetes account /v2/kubernetes/account/{id}/agentSummary: get: tags: - Kubernetes Account summary: Get Agent Summary operationId: KubernetesAccount_GetAgentSummary_get_/v2/kubernetes/account/{id}/agentSummary parameters: - name: id in: path required: true description: the Kubernetes account id schema: type: string format: guid x-position: 1 responses: '200': description: KubernetesAgentsSummaryViewModel content: application/json: schema: type: array items: $ref: '#/components/schemas/KubernetesAgentsSummaryViewModel' description: Get Kubernetes account agent summary data /v2/kubernetes/account/{id}/resolveMultipleOnboarding: post: tags: - Kubernetes Account summary: Resolve Multiple Onboarding operationId: KubernetesAccount_ResolveMultipleOnboarding_post_/v2/kubernetes/account/{id}/resolveMultipleOnboarding parameters: - name: id in: path required: true description: the Kubernetes account id schema: type: string format: guid x-position: 1 responses: '200': description: '' description: Unblock Kubernetes account due to Multiple Onboarding /v2/kubernetes/account/{id}/organizationalUnit: put: tags: - Kubernetes Account summary: Update Organizational Id operationId: KubernetesAccount_UpdateOrganizationalId_put_/v2/kubernetes/account/{id}/organizationalUnit parameters: - name: id in: path required: true description: The Guid ID of the Kubernetes account schema: type: string format: guid x-position: 1 requestBody: x-name: updateData description: The Guid ID of the Organizational Unit to attach to. Use null in order to attach to root Organizational Unit content: application/json: schema: $ref: '#/components/schemas/UpdateIdViewModel' required: true x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/KubernetesAccountViewModel' example: id: afc490f9-f9ff-4414-83ed-44885f2f4468 externalAccountNumber: afc490f9-f9ff-4414-83ed-44885f2f4468 threatIntelligenceEnabled: false imageAssuranceEnabled: false imageAccessRuntimeMonitorEnabled: false runtimeProtectionEnabled: false runtimeProtectionNetwork: false runtimeProtectionProfiling: false runtimeProtectionFileReputation: false admissionControlEnabled: false admissionControlFailOpen: true name: '' creationDate: '0001-01-01T00:00:00' vendor: kubernetes organizationalUnitId: null organizationalUnitPath: '' organizationalUnitName: '' clusterVersion: null clusterVersionStatus: Unknown clusterVersionStatusDescription: '' description: null platform: kubernetes type: 0 description: 'Update the ID of the Organizational unit that this cloud account will be attached to. Use ''null'' for root organizational unit' /v2/kubernetes/account/organizationalUnit/move: put: tags: - Kubernetes Account summary: Move Cloud Accounts To Organizational Unit operationId: KubernetesAccount_MoveCloudAccountsToOrganizationalUnit_put_/v2/kubernetes/account/organizationalUnit/move requestBody: x-name: moveData content: application/json: schema: $ref: '#/components/schemas/MoveOrganizationalUnitViewModel' required: true x-position: 1 responses: '200': description: '' content: application/octet-stream: schema: type: string format: binary description: 'Detach cloud accounts from an Organizational unit and attach them to another Organizational unit Use ''null'' for root organizational unit' /v2/kubernetes/account/organizationalUnit/moveAll: put: tags: - Kubernetes Account summary: Move All Cloud Accounts To Organizational Unit operationId: KubernetesAccount_MoveAllCloudAccountsToOrganizationalUnit_put_/v2/kubernetes/account/organizationalUnit/moveAll requestBody: x-name: updateData content: application/json: schema: $ref: '#/components/schemas/UpdateIdViewModel' required: true x-position: 1 responses: '200': description: '' content: application/octet-stream: schema: type: string format: binary description: Detach all Kubernetes accounts from their current organizational unit and attach them to a new one. Default is to root organizational unit /v2/kubernetes/account/organizationalUnit/attach: post: tags: - Kubernetes Account summary: Post Attach Multi operationId: KubernetesAccount_PostAttachMulti_post_/v2/kubernetes/account/organizationalUnit/attach requestBody: x-name: attachData content: application/json: schema: $ref: '#/components/schemas/AttachCloudAccountsViewModel' required: true x-position: 1 responses: '200': description: '' content: application/octet-stream: schema: type: string format: binary description: Attach several Kubernetes accounts to a specific Organizational Unit. User 'null' as root Organizational Unit as target /v2/containerRegistry/account: get: tags: - Container Registry Account summary: Get All operationId: ContainerRegistryAccount_GetAll_get_/v2/containerRegistry/account responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/ContainerRegistryAccountViewModel' example: - id: deddc959-cc56-489b-94f7-09cc38040100 creationDate: '0001-01-01T00:00:00' organizationalUnitPath: '' organizationalUnitName: '' name: '' registryUrl: '' organizationalUnitId: null linkedScanningEnvironments: - environmentId: 4cbf5a15-27a5-408d-887f-01a808f8eee5 pullSecretName: null tenantId: null applicationClientId: null scanningEnvironmentType: AWS registryAuthType: AcrServicePrincipal roleArn: null description: null platform: containerregistry type: ACR description: get all container registry post: tags: - Container Registry Account summary: Post operationId: ContainerRegistryAccount_Post_post_/v2/containerRegistry/account requestBody: x-name: model content: application/json: schema: $ref: '#/components/schemas/ContainerRegistryAccountPostModel' examples: ContainerRegistryAccountRequestModelExample: value: name: string description: string organizationalUnitId: 00000000-0000-0000-0000-000000000000 registryType: ACR registryUrl: string linkedScanningEnvironments: - environmentId: 0e7fa1b6-0911-4fb3-b932-2c0fdd9f8b6b pullSecretName: string tenantId: string applicationClientId: string scanningEnvironmentType: AWS registryAuthType: AcrServicePrincipal roleArn: null required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ContainerRegistryAccountViewModel' example: id: deddc959-cc56-489b-94f7-09cc38040100 creationDate: '0001-01-01T00:00:00' organizationalUnitPath: '' organizationalUnitName: '' name: '' registryUrl: '' organizationalUnitId: null linkedScanningEnvironments: - environmentId: 4cbf5a15-27a5-408d-887f-01a808f8eee5 pullSecretName: null tenantId: null applicationClientId: null scanningEnvironmentType: AWS registryAuthType: AcrServicePrincipal roleArn: null description: null platform: containerregistry type: ACR description: create new container registry /v2/containerRegistry/account/{id}: get: tags: - Container Registry Account summary: Get operationId: ContainerRegistryAccount_Get_get_/v2/containerRegistry/account/{id} parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ContainerRegistryAccountViewModel' example: id: deddc959-cc56-489b-94f7-09cc38040100 creationDate: '0001-01-01T00:00:00' organizationalUnitPath: '' organizationalUnitName: '' name: '' registryUrl: '' organizationalUnitId: null linkedScanningEnvironments: - environmentId: 4cbf5a15-27a5-408d-887f-01a808f8eee5 pullSecretName: null tenantId: null applicationClientId: null scanningEnvironmentType: AWS registryAuthType: AcrServicePrincipal roleArn: null description: null platform: containerregistry type: ACR description: get single container registry by id delete: tags: - Container Registry Account summary: Delete operationId: ContainerRegistryAccount_Delete_delete_/v2/containerRegistry/account/{id} parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 responses: '200': description: '' description: delete container registry /v2/containerRegistry/account/{id}/accountDescription: put: tags: - Container Registry Account operationId: ContainerRegistryAccount_UpdateAccountDescription_put_/v2/containerRegistry/account/{id}/accountDescription parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 - name: description in: query schema: type: string maxLength: 1000 pattern: ^[\p{L}\p{M}0-9\s\-_'.,#/@;:!=]*$ nullable: true x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ContainerRegistryAccountViewModel' example: id: deddc959-cc56-489b-94f7-09cc38040100 creationDate: '0001-01-01T00:00:00' organizationalUnitPath: '' organizationalUnitName: '' name: '' registryUrl: '' organizationalUnitId: null linkedScanningEnvironments: - environmentId: 4cbf5a15-27a5-408d-887f-01a808f8eee5 pullSecretName: null tenantId: null applicationClientId: null scanningEnvironmentType: AWS registryAuthType: AcrServicePrincipal roleArn: null description: null platform: containerregistry type: ACR description: '' summary: Update Account Description /v2/containerRegistry/account/{id}/accountName/{newName}: put: tags: - Container Registry Account summary: Update Account Name operationId: ContainerRegistryAccount_UpdateAccountName_put_/v2/containerRegistry/account/{id}/accountName/{newName} parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 - name: newName in: path required: true schema: type: string maxLength: 500 pattern: ^[\p{L}\p{M}0-9\s\-_'.,#/@;:!=]*$ x-position: 2 responses: '200': description: '' description: updating container registry name /v2/containerRegistry/account/{id}/linkedScanningEnvironments: put: tags: - Container Registry Account summary: Update Linked Scanning Environments operationId: ContainerRegistryAccount_UpdateLinkedScanningEnvironments_put_/v2/containerRegistry/account/{id}/linkedScanningEnvironments parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 requestBody: x-name: model content: application/json: schema: type: array items: $ref: '#/components/schemas/ContainerRegistryLinkedEnvironmentViewModel' examples: LinkedEnvironmentsListRequestModelExample: value: - environmentId: c683d992-61ee-4d9e-81d9-7214cb9ee104 pullSecretName: null tenantId: null applicationClientId: null scanningEnvironmentType: AWS registryAuthType: AcrServicePrincipal roleArn: null required: true x-position: 2 responses: '200': description: '' description: update linkedScanningEnvironments /v2/containerRegistry/account/{id}/linkedScanningEnvironment: put: tags: - Container Registry Account summary: Update Linked Scanning Environment operationId: ContainerRegistryAccount_UpdateLinkedScanningEnvironment_put_/v2/containerRegistry/account/{id}/linkedScanningEnvironment parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 requestBody: x-name: model content: application/json: schema: $ref: '#/components/schemas/ContainerRegistryLinkedEnvironmentViewModel' examples: LinkedEnvironmentsListRequestModelExample: value: - environmentId: c683d992-61ee-4d9e-81d9-7214cb9ee104 pullSecretName: null tenantId: null applicationClientId: null scanningEnvironmentType: AWS registryAuthType: AcrServicePrincipal roleArn: null required: true x-position: 2 responses: '200': description: '' description: update or add linkedScanningEnvironment /v2/containerRegistry/account/{id}/linkedScanningEnvironment/{linkedEnvironmentId}: delete: tags: - Container Registry Account summary: Delete Linked Scanning Environment operationId: ContainerRegistryAccount_DeleteLinkedScanningEnvironment_delete_/v2/containerRegistry/account/{id}/linkedScanningEnvironment/{linkedEnvironmentId} parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 - name: linkedEnvironmentId in: path required: true schema: type: string format: guid x-position: 2 responses: '200': description: '' description: delete single linkedScanningEnvironment from containerRegistry /v2/containerRegistry/account/{id}/settings: put: tags: - Container Registry Account summary: Set Environment Settings operationId: ContainerRegistryAccount_SetEnvironmentSettings_put_/v2/containerRegistry/account/{id}/settings parameters: - name: id in: path required: true description: The Container registry account id schema: type: string format: guid x-position: 1 requestBody: x-name: settings content: application/json: schema: $ref: '#/components/schemas/ContainerRegistryUserConfigurationsViewModel' required: true x-position: 2 responses: '200': description: '' description: Set user configurable properties for the environment patch: tags: - Container Registry Account summary: Update Environment Settings operationId: ContainerRegistryAccount_UpdateEnvironmentSettings_patch_/v2/containerRegistry/account/{id}/settings parameters: - name: id in: path required: true description: The Container registry account id schema: type: string format: guid x-position: 1 requestBody: x-name: settings content: application/json: schema: $ref: '#/components/schemas/ContainerRegistryUserConfigurationsViewModel' required: true x-position: 2 responses: '200': description: '' description: Update user configurable properties for the environment get: tags: - Container Registry Account summary: Get Environment Settings operationId: ContainerRegistryAccount_GetEnvironmentSettings_get_/v2/containerRegistry/account/{id}/settings parameters: - name: id in: path required: true description: The Container registry account id schema: type: string format: guid x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ContainerRegistryUserConfigurationsViewModel' description: Get user configurable properties for the environment /v2/containerRegistry/account/{id}/organizationalUnit: put: tags: - Container Registry Account summary: Update Organizational Id operationId: ContainerRegistryAccount_UpdateOrganizationalId_put_/v2/containerRegistry/account/{id}/organizationalUnit parameters: - name: id in: path required: true description: The Guid ID of the container registry account schema: type: string format: guid x-position: 1 requestBody: x-name: updateData description: The Guid ID of the Organizational Unit to attach to. Use null in order to attach to root Organizational Unit content: application/json: schema: $ref: '#/components/schemas/UpdateIdViewModel' required: true x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ContainerRegistryAccountViewModel' example: id: deddc959-cc56-489b-94f7-09cc38040100 creationDate: '0001-01-01T00:00:00' organizationalUnitPath: '' organizationalUnitName: '' name: '' registryUrl: '' organizationalUnitId: null linkedScanningEnvironments: - environmentId: 4cbf5a15-27a5-408d-887f-01a808f8eee5 pullSecretName: null tenantId: null applicationClientId: null scanningEnvironmentType: AWS registryAuthType: AcrServicePrincipal roleArn: null description: null platform: containerregistry type: ACR description: 'Update the ID of the Organizational unit that this cloud account will be attached to. Use ''null'' for root organizational unit' /v2/containerRegistry/account/organizationalUnit/move: put: tags: - Container Registry Account summary: Move Cloud Accounts To Organizational Unit operationId: ContainerRegistryAccount_MoveCloudAccountsToOrganizationalUnit_put_/v2/containerRegistry/account/organizationalUnit/move requestBody: x-name: moveData content: application/json: schema: $ref: '#/components/schemas/MoveOrganizationalUnitViewModel' required: true x-position: 1 responses: '200': description: '' content: application/octet-stream: schema: type: string format: binary description: 'Detach cloud accounts from an Organizational unit and attach them to another Organizational unit Use ''null'' for root organizational unit' /v2/containerRegistry/account/organizationalUnit/moveAll: put: tags: - Container Registry Account summary: Move All Cloud Accounts To Organizational Unit operationId: ContainerRegistryAccount_MoveAllCloudAccountsToOrganizationalUnit_put_/v2/containerRegistry/account/organizationalUnit/moveAll requestBody: x-name: updateData content: application/json: schema: $ref: '#/components/schemas/UpdateIdViewModel' required: true x-position: 1 responses: '200': description: '' content: application/octet-stream: schema: type: string format: binary description: Detach all container registry accounts from their current organizational unit and attach them to a new one. Default is to root organizational unit /v2/containerRegistry/account/organizationalUnit/attach: post: tags: - Container Registry Account summary: Post Attach Multi operationId: ContainerRegistryAccount_PostAttachMulti_post_/v2/containerRegistry/account/organizationalUnit/attach requestBody: x-name: attachData content: application/json: schema: $ref: '#/components/schemas/AttachCloudAccountsViewModel' required: true x-position: 1 responses: '200': description: '' content: application/octet-stream: schema: type: string format: binary description: Attach several container registry accounts to a specific Organizational Unit. User 'null' as root Organizational Unit as target /v2/containerRegistry/account/{id}/agentSummary: get: tags: - Container Registry Account summary: Get Agent Summary operationId: ContainerRegistryAccount_GetAgentSummary_get_/v2/containerRegistry/account/{id}/agentSummary parameters: - name: id in: path required: true description: the Container registry account id schema: type: string format: guid x-position: 1 responses: '200': description: ContainerRegistryAgentSummaryViewModel content: application/json: schema: type: array items: $ref: '#/components/schemas/ContainerRegistryAgentSummaryViewModel' description: Get Container registry account agent summary data /v2/containerRegistry/account/accountAgentStatus: get: tags: - Container Registry Account summary: Get Account Agent Status operationId: ContainerRegistryAccount_GetAccountAgentStatus_get_/v2/containerRegistry/account/accountAgentStatus responses: '200': description: List of ContainerRegistryStatusViewModel content: application/json: schema: type: array items: $ref: '#/components/schemas/ContainerRegistryAccountAgentSummaryViewModel' description: Get container registry account agents status /v2/containerRegistry/account/{id}/accountSummary: get: tags: - Container Registry Account summary: Get Account Summary operationId: ContainerRegistryAccount_GetAccountSummary_get_/v2/containerRegistry/account/{id}/accountSummary parameters: - name: id in: path required: true description: the Container registry account id schema: type: string format: guid x-position: 1 responses: '200': description: ContainerRegistryAccountSummaryViewModel content: application/json: schema: $ref: '#/components/schemas/ContainerRegistryAccountSummaryViewModel' description: Get Container registry account summary data /v2/oci-cloud-account: get: tags: - Oci Cloud Account summary: Get All Oci Cloud Accounts operationId: OciCloudAccount_GetAllOciCloudAccounts_get_/v2/oci-cloud-account responses: '200': description: List of OCI cloud accounts content: application/json: schema: type: array items: $ref: '#/components/schemas/OciCloudAccountViewModel' description: Get a list of all OCI cloud accounts post: tags: - Oci Cloud Account summary: Add Oci Cloud Account operationId: OciCloudAccount_AddOciCloudAccount_post_/v2/oci-cloud-account requestBody: x-name: ociAccountCreationInput content: application/json: schema: $ref: '#/components/schemas/OciAccountCreationInput' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/OciCloudAccountViewModel' description: 'The second step in the onboarding ("create-terraform" API call is the first step): Add (onboard) a new OCI cloud account to CloudGuard' delete: tags: - Oci Cloud Account summary: Delete Oci Cloud Account operationId: OciCloudAccount_DeleteOciCloudAccount_delete_/v2/oci-cloud-account parameters: - name: id in: query schema: type: string format: guid x-position: 1 responses: '200': description: '' description: Delete an OCI account from a CloudGuard account (the OCI account is not deleted from OCI) /v2/oci-cloud-account/{id}: get: tags: - Oci Cloud Account summary: Get Oci Cloud Accounts By Id operationId: OciCloudAccount_GetOciCloudAccountsById_get_/v2/oci-cloud-account/{id} parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/OciCloudAccountViewModel' description: Get details for a specific OCI Cloud Account /v2/oci-cloud-account/create-terraform: post: tags: - Oci Cloud Account summary: Save Temp Data And Export Terraform Conf File operationId: OciCloudAccount_SaveTempDataAndExportTerraformConfFile_post_/v2/oci-cloud-account/create-terraform requestBody: x-name: data content: application/json: schema: $ref: '#/components/schemas/OciCloudAccountTempDataCreationModel' required: true x-position: 1 responses: '200': description: Terraform configuration file content: application/octet-stream: schema: type: string format: binary description: 'The first step in the onboarding (with terraform file): Save temp data for the onboarding process and export terraform configuration file. The Terraform should be run in the OCI account: Navigate to "Developer" -> "ServicesResource" -> "ManagerStacks", and select "Create Stack".' /v2/oci-cloud-account/save-temp-data: post: tags: - Oci Cloud Account summary: Save Temp Data operationId: OciCloudAccount_SaveTempData_post_/v2/oci-cloud-account/save-temp-data requestBody: x-name: data content: application/json: schema: $ref: '#/components/schemas/OciCloudAccountTempDataCreationModel' required: true x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/OciCloudAccountViewModel' description: 'The first step in the onboarding (without terraform file): Save temp data for the onboarding process. To use this call the OCI API must be used.' /v2/oci-cloud-account/{id}/delete-force: delete: tags: - Oci Cloud Account summary: Force Delete Oci Cloud Account operationId: OciCloudAccount_ForceDeleteOciCloudAccount_delete_/v2/oci-cloud-account/{id}/delete-force parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 responses: '200': description: '' description: Delete an OCI account from a CloudGuard account (the OCI account is not deleted from OCI) and linked entities /v2/oci-cloud-account/{id}/account-name: put: tags: - Oci Cloud Account summary: Update Account Name operationId: OciCloudAccount_UpdateAccountName_put_/v2/oci-cloud-account/{id}/account-name parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 requestBody: x-name: name content: application/json: schema: $ref: '#/components/schemas/OciAccountNameViewModel' required: true x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/OciCloudAccountViewModel' description: Update an OCI Cloud account name (as it appears in CloudGuard) /v2/oci-cloud-account/{id}/credentials: put: tags: - Oci Cloud Account summary: Update Credentials operationId: OciCloudAccount_UpdateCredentials_put_/v2/oci-cloud-account/{id}/credentials parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/OciCloudAccountViewModel' description: Update an OCI Cloud credentials after terraform run has finished successfully /v2/oci-cloud-account/{id}/credentials-terraform: put: tags: - Oci Cloud Account summary: Update Credentials Terraform operationId: OciCloudAccount_UpdateCredentialsTerraform_put_/v2/oci-cloud-account/{id}/credentials-terraform parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 responses: '200': description: '' content: application/octet-stream: schema: type: string format: binary description: Update an OCI Cloud credentials request before creating stack with the Terraform file /v2/oci-cloud-account/{id}/sync-now: post: tags: - Oci Cloud Account operationId: OciCloudAccount_SyncNow_post_/v2/oci-cloud-account/{id}/sync-now parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/OciCloudAccountViewModel' description: '' summary: Sync Now /v2/oci-cloud-account/missing-permissions: get: tags: - Oci Cloud Account summary: Get Missing Permissions All operationId: OciCloudAccount_GetMissingPermissionsAll_get_/v2/oci-cloud-account/missing-permissions responses: '200': description: A list of missing permissions for the OCI cloud accounts in CloudGuard content: application/json: schema: type: array items: $ref: '#/components/schemas/CloudAccountMissingPermissionsViewModel' description: Get a list of missing permissions (needed by CloudGuard to manage the accounts) for all OCI accounts in CloudGuard /v2/oci-cloud-account/{id}/missing-permissions: get: tags: - Oci Cloud Account summary: Get Missing Permissions operationId: OciCloudAccount_GetMissingPermissions_get_/v2/oci-cloud-account/{id}/missing-permissions parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 - name: showIgnored in: query schema: type: boolean default: true x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/CloudAccountMissingPermissionsIgnorableViewModel' description: Get a list of missing permissions for a specific account. These permissions are needed by Dome9 to manage accounts. put: tags: - Oci Cloud Account summary: Update Ignorable Missing Permissions operationId: OciCloudAccount_UpdateIgnorableMissingPermissions_put_/v2/oci-cloud-account/{id}/missing-permissions parameters: - name: id in: path required: true description: CloudAccountId schema: type: string format: guid x-position: 1 requestBody: x-name: permissionsToIgnoreOrRestore description: List of permissions to set ignore or restore flag to content: application/json: schema: type: array items: $ref: '#/components/schemas/MissingPermissionsIgnorableUpdateViewModel' required: true x-position: 2 responses: '200': description: '' description: Get a list of missing permissions for a specific account. These are permissions needed by Dome9 to manage accounts. /v2/oci-cloud-account/{id}/missing-permissions/entity-type: get: tags: - Oci Cloud Account summary: Get Missing Permissions By Entity Type operationId: OciCloudAccount_GetMissingPermissionsByEntityType_get_/v2/oci-cloud-account/{id}/missing-permissions/entity-type parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 - name: entityType in: query schema: type: string nullable: true x-position: 2 - name: subType in: query schema: type: string default: '' nullable: true x-position: 3 responses: '200': description: A list of missing permissions content: application/json: schema: type: array items: $ref: '#/components/schemas/MissingPermissionViewModel' description: Get missing permissions for a specific entity type for a specific OCI Cloud account /v2/oci-cloud-account/{id}/missing-permissions/reset: put: tags: - Oci Cloud Account summary: Reset Missing Permissions operationId: OciCloudAccount_ResetMissingPermissions_put_/v2/oci-cloud-account/{id}/missing-permissions/reset parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 responses: '200': description: '' description: "Reset (re-validate) a OCI Cloud account credentials in CloudGuard. \nWill cause all entities to retry\ \ fetching from the OCI cloud account." /v2/oci-cloud-account/{id}/organizational-unit: put: tags: - Oci Cloud Account summary: Update Organizational Unit Id operationId: OciCloudAccount_UpdateOrganizationalUnitId_put_/v2/oci-cloud-account/{id}/organizational-unit parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 requestBody: x-name: updateData content: application/json: schema: $ref: '#/components/schemas/UpdateIdViewModel' required: true x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/OciCloudAccountViewModel' description: 'Update the ID of the Organizational Unit that this cloud account will be attached to. Use ''null'' for the root organizational unit' /v2/oci-cloud-account/organizational-unit/move: put: tags: - Oci Cloud Account summary: Move Cloud Accounts To Organizational Unit operationId: OciCloudAccount_MoveCloudAccountsToOrganizationalUnit_put_/v2/oci-cloud-account/organizational-unit/move requestBody: x-name: moveData content: application/json: schema: $ref: '#/components/schemas/MoveOrganizationalUnitViewModel' required: true x-position: 1 responses: '200': description: '' content: application/octet-stream: schema: type: string format: binary description: 'Detach cloud accounts from an Organizational unit and attach them to another Organizational unit. Use ''null'' for root organizational unit' /v2/oci-cloud-account/organizational-unit/move-all: put: tags: - Oci Cloud Account summary: Move All Cloud Accounts To Organizational Unit operationId: OciCloudAccount_MoveAllCloudAccountsToOrganizationalUnit_put_/v2/oci-cloud-account/organizational-unit/move-all requestBody: x-name: updateData content: application/json: schema: $ref: '#/components/schemas/UpdateIdViewModel' required: true x-position: 1 responses: '200': description: '' content: application/octet-stream: schema: type: string format: binary description: Detach all cloud accounts from their current organizational unit and attach them to a new one. Default is to root organizational unit /v2/oci-cloud-account/organizational-unit/attach: post: tags: - Oci Cloud Account summary: Attach Multi Organizational Unit operationId: OciCloudAccount_AttachMultiOrganizationalUnit_post_/v2/oci-cloud-account/organizational-unit/attach requestBody: x-name: attachData content: application/json: schema: $ref: '#/components/schemas/AttachCloudAccountsViewModel' required: true x-position: 1 responses: '200': description: '' content: application/octet-stream: schema: type: string format: binary description: Attach several cloud accounts to a specific Organizational Unit. User 'null' as root Organizational Unit as target /v2/aws-organization-management: post: tags: - Aws Organization Management summary: Create Organization Management operationId: AwsOrganizationManagement_CreateOrganizationManagement_post_/v2/aws-organization-management requestBody: x-name: onboardingRequest content: application/json: schema: $ref: '#/components/schemas/OnboardingRequest' required: true x-position: 1 responses: '200': description: Returns the created AWS organization management entity. content: application/json: schema: $ref: '#/components/schemas/OrganizationManagementViewModel' description: Create new AWS organization management entity. get: tags: - Aws Organization Management summary: Get All Organization Management operationId: AwsOrganizationManagement_GetAllOrganizationManagement_get_/v2/aws-organization-management parameters: - name: externalOrganizationId x-originalName: externalOrganizationIds in: query style: form explode: true schema: type: array items: type: string x-position: 1 responses: '200': description: Returns a collection of AWS organization management entities content: application/json: schema: type: array items: $ref: '#/components/schemas/OrganizationManagementViewModel' description: Get AWS organization management entities. /v2/aws-organization-management/{id}: put: tags: - Aws Organization Management summary: Update Organization Management operationId: AwsOrganizationManagement_UpdateOrganizationManagement_put_/v2/aws-organization-management/{id} parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 requestBody: x-name: onboardingUpdateRequest content: application/json: schema: $ref: '#/components/schemas/OnboardingUpdateRequest' required: true x-position: 2 responses: '200': description: Returns the AWS organization management entity. description: Update existing AWS organization management entity. get: tags: - Aws Organization Management summary: Get Organization Management By Id operationId: AwsOrganizationManagement_GetOrganizationManagementById_get_/v2/aws-organization-management/{id} parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 responses: '200': description: Returns a single AWS organization management entity corresponding to the given ID content: application/json: schema: $ref: '#/components/schemas/OrganizationManagementViewModel' description: Get AWS organization management entity by its ID. delete: tags: - Aws Organization Management summary: Delete operationId: AwsOrganizationManagement_Delete_delete_/v2/aws-organization-management/{id} parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 responses: '200': description: '' description: 'Delete AWS organization management After this API call each account that is under this organization need to be deleted separately.' /v2/aws-organization-management/{id}/stackset-arn: put: tags: - Aws Organization Management summary: Update Stack Set Arn operationId: AwsOrganizationManagement_UpdateStackSetArn_put_/v2/aws-organization-management/{id}/stackset-arn parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 requestBody: x-name: updateStackSetArnRequest content: application/json: schema: $ref: '#/components/schemas/UpdateStackSetArnRequest' required: true x-position: 2 responses: '200': description: '' description: Update existing AWS organization management entity with the StackSet arn. /v2/aws-organization-management/{id}/configuration: put: tags: - Aws Organization Management summary: Update Configuration operationId: AwsOrganizationManagement_UpdateConfiguration_put_/v2/aws-organization-management/{id}/configuration parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/UpdateConfigurationRequest' required: true x-position: 2 responses: '200': description: '' description: Update organization configuration. /v2/aws-organization-management/{id}/missing-permissions/reset: put: tags: - Aws Organization Management summary: Reset Missing Permissions operationId: AwsOrganizationManagement_ResetMissingPermissions_put_/v2/aws-organization-management/{id}/missing-permissions/reset parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 responses: '200': description: '' description: Resets all environments of the given aws organization id. /v2/aws-organization-management-onboarding/management-stack: get: tags: - Aws Organization Management Onboarding summary: Get Onboarding Configuration operationId: AwsOrganizationManagementOnboarding_GetOnboardingConfiguration_get_/v2/aws-organization-management-onboarding/management-stack parameters: - name: awsAccountId in: query schema: type: string nullable: true x-position: 1 responses: '200': description: Return management stack configuration content: application/json: schema: $ref: '#/components/schemas/ManagementCftConfiguration' description: 'Get management stack configuration for given AWS account. For empty awsAccountId, return the default configuration.' /v2/aws-organization-management-onboarding/member-account-configuration: get: tags: - Aws Organization Management Onboarding summary: Get Member Account Configuration operationId: AwsOrganizationManagementOnboarding_GetMemberAccountConfiguration_get_/v2/aws-organization-management-onboarding/member-account-configuration responses: '200': description: Return onboarding CFT content: application/json: schema: $ref: '#/components/schemas/OnboardingMemberCft' description: Get onboarding CFT. /v2/azure-organization-management: post: tags: - Azure Organization Management summary: Create Organization Management operationId: AzureOrganizationManagement_CreateOrganizationManagement_post_/v2/azure-organization-management requestBody: x-name: onboardingRequest content: application/json: schema: $ref: '#/components/schemas/OnboardingRequest2' required: true x-position: 1 responses: '200': description: Returns the created Azure organization management entity. content: application/json: schema: $ref: '#/components/schemas/OrganizationManagementViewModel2' description: Create new Azure organization management entity. get: tags: - Azure Organization Management summary: Get All Organization Management operationId: AzureOrganizationManagement_GetAllOrganizationManagement_get_/v2/azure-organization-management parameters: - name: ManagementGroupId x-originalName: managementGroupIds in: query style: form explode: true schema: type: array items: type: string x-position: 1 responses: '200': description: Returns a collection of Azure organization management entities content: application/json: schema: type: array items: nullable: true oneOf: - $ref: '#/components/schemas/OrganizationManagementViewModel2' description: Get Azure organization management entities. /v2/azure-organization-management/{id}: put: tags: - Azure Organization Management summary: Update Organization Management operationId: AzureOrganizationManagement_UpdateOrganizationManagement_put_/v2/azure-organization-management/{id} parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 requestBody: x-name: onboardingUpdateRequest content: application/json: schema: $ref: '#/components/schemas/OnboardingUpdateRequest2' required: true x-position: 2 responses: '200': description: '' description: Update existing Azure organization management entity name by its ID. get: tags: - Azure Organization Management summary: Get Organization Management By Id operationId: AzureOrganizationManagement_GetOrganizationManagementById_get_/v2/azure-organization-management/{id} parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 responses: '200': description: Returns a single Azure organization management entity corresponding to the given ID content: application/json: schema: $ref: '#/components/schemas/OrganizationManagementViewModel2' description: Get Azure organization management entity by its ID. delete: tags: - Azure Organization Management summary: Delete operationId: AzureOrganizationManagement_Delete_delete_/v2/azure-organization-management/{id} parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 responses: '200': description: '' description: 'Delete Azure organization management. After this API call each account that is under this organization need to be deleted separately.' /v2/azure-organization-management/tenant/{tenantId}/management-group/{managementGroupId}: get: tags: - Azure Organization Management summary: Get Azure Organization Management By Tenant And Management Group operationId: AzureOrganizationManagement_GetAzureOrganizationManagementByTenantAndManagementGroup_get_/v2/azure-organization-management/tenant/{tenantId}/management-group/{managementGroupId} parameters: - name: tenantId in: path required: true schema: type: string format: guid x-position: 1 - name: managementGroupId in: path required: true schema: type: string x-position: 2 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/OrganizationManagementViewModel2' description: 'Get Azure organization management by Tenant Id and Management Group Id. The Azure Tenant Id. Management Group Id or Tenant Id.' /v2/azure-organization-management/{id}/missing-permissions/reset: put: tags: - Azure Organization Management summary: Reset Missing Permissions operationId: AzureOrganizationManagement_ResetMissingPermissions_put_/v2/azure-organization-management/{id}/missing-permissions/reset parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 responses: '200': description: '' description: Resets all environments of the given CloudGuard's Azure organization management id. /v2/gcp-organization-management/execution-command: get: tags: - Gcp Organization Management summary: Generate Onboarding Execution Command operationId: GcpOrganizationManagement_GenerateOnboardingExecutionCommand_get_/v2/gcp-organization-management/execution-command parameters: - name: WorkflowId in: query description: Not required schema: type: string format: guid x-position: 1 - name: ScopeMode in: query description: 'Required: Scope of the onboarding' schema: $ref: '#/components/schemas/ScopeMode' x-position: 2 - name: ServiceAccountProjectId in: query description: Optional if scope is Project ID. Otherwise required schema: type: string nullable: true x-position: 3 - name: ManagedServiceAccountId in: query description: Not required. A new service account will be created if not provided schema: type: string nullable: true x-position: 4 - name: ProjectId in: query description: Required only if ScopeMode = Project schema: type: string nullable: true x-position: 5 - name: FolderId in: query description: Required only if ScopeMode = Folder schema: type: string nullable: true x-position: 6 - name: OrganizationId in: query description: Required only if ScopeMode = Organization schema: type: string nullable: true x-position: 7 - name: IsUpdate in: query description: 'Required: Default is false. Specifies if the flow is update flow or create flow. If IsUpdate = false create_key will be added to the script and new access keys will be returned to the user. If IsUpdate = true create_key will not be added to the script (for update permissions only)' schema: type: boolean x-position: 8 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/GcpOnboardingExecCmdResponse' description: 'Get the cloud account command line execution for GCP shell Details for GCP cloud account.' /v2/gcp-organization-management/onboarding-execution-preview: get: tags: - Gcp Organization Management summary: Get Onboarding Script For Preview operationId: GcpOrganizationManagement_GetOnboardingScriptForPreview_get_/v2/gcp-organization-management/onboarding-execution-preview responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/GetOnboardingScriptForPreviewResponse' description: Get the script that performs GCP account onboarding tags: - name: AccessLease description: Access Leases - name: AccessLeaseInvitation description: Access Lease Invitations - name: Account - name: AccountLimitation - name: AccountPollingInterval - name: AccountRegistration - name: AccountTrust description: "Allow you to define a trust between accounts in order to allow users in a certain account to make changes\ \ and operation on another account.\nActions can be taken on a trustee account via a role which is defined on it. \nThe\ \ role should be assumed by a user from the trusted account." - name: Agent - name: Agentless description: Agentless Workload Posture - name: Alert - name: AlibabaCloudAccount description: Alibaba Cloud Accounts - name: Application - name: Assessment description: Run and View Compliance Assessments - name: AssessmentHistory - name: AssessmentHistoryV2 description: Compliance Assessment History - name: Audit description: Audit logs - name: Auth - name: Aws Cloud Account description: Manage AWS Cloud Accounts - name: AwsAppSync - name: AwsBackupVault - name: AwsConfigSettings - name: AwsCustomerGateway - name: AwsEcsTask - name: AwsEks - name: AwsElasticIp - name: AwsElasticsearchDomain - name: AwsEmrCluster - name: AwsInspectorFindings - name: AwsInspectorRuns - name: AwsLoadBalancersNetworkInterfaces - name: AwsOrganizations - name: AwsQuickSightAccount - name: AwsQuickSightGroup - name: AwsQuickSightUser - name: AwsQuickSightVpcConnections - name: AwsSageMaker - name: AwsSecurityGroup - name: AwsSecurityGroupPolicy - name: AwsSecurityGroupsIndex - name: AwsUnifiedOnboarding description: Aws Unified Onboarding - name: AwsVpcEndpoint - name: AzureAnalysisService - name: AzureApplicationGateway - name: AzureApplicationSecurityGroup - name: AzureCloudAccount description: Onboard Azure accounts - name: AzureComputeGalleryImage - name: AzureCosmosDbAccount - name: AzureDisk - name: AzureFunction - name: AzureKeyVault - name: AzureKubernetes - name: AzureLoadBalancer - name: AzureLock - name: AzureLogicApp - name: AzureLogProfile - name: AzurePolicyAssignment - name: AzureRedisCache - name: AzureResourceGroup - name: AzureRouteTable - name: AzureSecurityGroup - name: AzureSecurityGroupPolicy description: Azure Network Security Group Policies - name: AzureSnapshot - name: AzureSqlDb - name: AzureSqlServer - name: AzureStorageAccounts - name: AzureStorageBlobContainer - name: AzureSubnet - name: AzureUser - name: AzureVirtualMachine - name: AzureVirtualMachineImage - name: AzureVirtualMachineScaleSet - name: AzureVirtualNetworkPeering - name: AzureWebApp - name: BigTable - name: BillableAssets description: Retrieve billable assets data - name: BillableAssetsReport description: Billable Assets Report - name: Billing - name: Clarity - name: CloudAcmCertificate - name: CloudAmi - name: CloudAutoScalingGroup - name: CloudDbInstance - name: CloudDirectConnect - name: CloudDynamoDb - name: CloudEcsCluster - name: CloudEcsService description: Cloud Ecs Service - name: CloudEcsTaskDefinition - name: CloudEfs - name: CloudElastiCacheCluster - name: CloudFlowLogs - name: CloudFrontDistribution - name: CloudGuardDutyDetector - name: CloudIamAccountSummary - name: CloudIamCredentialReport - name: CloudIamGroup - name: CloudIamPasswordPolicy - name: CloudIamPolicy - name: CloudIamRole - name: CloudIamServerCertificate - name: CloudIamUser - name: CloudIamVirtualMfaDevice - name: CloudInfraUser description: CloudInfra Users - name: CloudInstance description: Cloud Instances - name: CloudInternetGateway - name: CloudKinesisStream - name: CloudKms - name: CloudKmsAlias - name: CloudLambdaFunction description: Cloud Lambda Function - name: CloudLoadBalancer - name: CloudLogGroups - name: CloudMetricAlarm - name: CloudNacl - name: CloudNetworkInterfaces - name: CloudRedshiftCluster - name: CloudRegion - name: CloudRoute53Domain - name: CloudRoute53HostedZone - name: CloudRoute53RecordSetGroup - name: CloudRouteTable - name: CloudS3Bucket description: '' - name: CloudSecurityGroup description: AWS Security Groups - name: CloudSnsSubscription - name: CloudSnsTopic - name: CloudSql - name: CloudSqs description: '' - name: CloudSubnet - name: CloudTrail description: CloudTrail - name: CloudVolume - name: CloudVpc - name: CloudVpcPeeringConnection - name: CloudVPNConnection - name: CloudVpnGateway - name: CloudWAFRegional - name: CloudWatchEventsRule description: CloudWatchEventsRule - name: ComplianceExclusion description: Compliance Exclusions - name: CompliancePolicy - name: ComplianceRemediation description: Compliance Remediation - name: ComplianceRemediationOld description: Compliance Remediation - DEPRECATED - please use /Compliance/Remediation instead - name: ComplianceRuleset description: ComplianceRuleset - name: ContinuousComplianceNotification description: Continuous Compliance Notification Policies - name: ContinuousCompliancePolicy - name: ContinuousCompliancePolicyV2 description: Continuous Compliance Policies - name: EmergencyPolicy - name: EntityFetchStatus - name: EntityReport - name: ExclusionOld description: Compliance Exclusions - DEPRECATED - please use /Compliance/Exclusion instead - name: ExternalFindings description: Findings from External (3rd-party) systems - name: Fim - name: Finding description: Compliance Findings - name: FindingsReport description: Compliance Findings csv reports - name: GcpBigQuery - name: GcpDisk - name: GcpGkeCluster - name: GcpImage - name: GcpKmsKeyRing - name: GcpProjectInfo description: Google Cloud Project Info - name: GcpPubSub - name: GcpSecurityGroup - name: GcpServiceAccount - name: GcpStorageBucket - name: GenericList description: Generic Lists - name: GlobalSearch description: Global search for all CloudGuard services - name: GoogleCloudAccount description: Google Cloud Accounts - name: GoogleCloudFirewallRule - name: GoogleCloudFunction - name: GoogleCloudIamPolicy - name: GoogleCloudNetwork description: Google Cloud Network - name: GoogleCloudSubnet - name: GoogleCloudVMInstance - name: Home - name: IamSafeLease description: IAM Safety Leases - name: IncidentsStatus - name: InfrastructureAssessment - name: Intelligence description: CloudGuard Intelligence allows you to visualize and analyze Account Activity and Network Traffic into and out of your cloud environment. - name: IpAddressMetadata description: IP Address Metadata - name: IpList description: IP Lists - name: LicenseActivator - name: Licensing - name: ManagedGenericList - name: Msp - name: OrganizationalUnit description: Manage Organizational Units - name: Permission - name: ProtectedAsset - name: ProtectedAssetsReport description: Compliance Protected Asset csv reports - name: ProtegoStatistics description: Protego statistics by dates - name: Role description: CloudGuard Roles - name: RulesEngine - name: SecurityGroup - name: Serverless - name: ServerlessPolicy description: Serverless policy - name: ServiceAccount description: CloudGuard Service Accounts - name: ServicePort - name: Settings description: Account Settings - name: ShiftLeft description: ShiftLeft - name: SystemHealth - name: TenableAccount description: Onboard Tenable accounts - name: User description: CloudGuard account users - name: BaseImage description: '' - name: ContainerRegistryAccount description: Container Registry Account - name: ContainerRegistryAccountInternal description: '' - name: ContainerRegistryImageAssurancePolicy description: '(deprecated: move to use /v2/vulnerability/policy)' - name: Dashboard description: '' - name: EcsConfiguration description: '' - name: EcsImageAssurancePolicy description: '(deprecated: move to use /v2/vulnerability/policy)' - name: EcsImageScan description: ECS Image Scan Configuration - name: Environment description: '' - name: ImageAdmissionExclusion description: '[Preview feature] Kubernetes Image admission exclusions' - name: ImageAssuranceDashboard description: '' - name: ImageAssuranceReport description: '' - name: KubernetesAccount description: Kubernetes Accounts - name: KubernetesAccountInternal description: '' - name: KubernetesAccountOld description: '(deprecated: this api is deprecated, please use ''/v2/kubernetes/account'' instead)' - name: KubernetesAdmissionControl description: Kubernetes Admission Control - name: KubernetesAdmissionControlPoliciesSummary description: '' - name: KubernetesClusterRole description: '' - name: KubernetesImage description: '' - name: KubernetesImageAdmissionExclusion description: '[Preview feature] Kubernetes Image admission exclusions (deprecated: this api is deprecated, please use ''/v2/kubernetes/admissionControl/imageAdmissionExclusion'' instead)' - name: KubernetesImageAssurance description: Kubernetes Image Assurance - name: KubernetesImageAssurancePolicy description: 'Kubernetes Image Assurance Policy (deprecated: move to use /v2/vulnerability/policy)' - name: KubernetesIngress description: '' - name: KubernetesNetworkPolicy description: '' - name: KubernetesNode description: '' - name: KubernetesPod description: '' - name: KubernetesPodGroup description: Kubernetes Pod Groups - name: KubernetesPodGroupOwner description: '' - name: KubernetesPodSecurityPolicy description: '' - name: KubernetesRole description: '' - name: KubernetesRuntimeAssurance description: '' - name: KubernetesService description: '' - name: KubernetesServiceAccount description: '' - name: Shiftleft description: '' - name: ShiftLeftAccount description: ShiftLeft - name: ShiftLeftPolicy description: 'ShiftLeft Policy (deprecated: move to use /v2/vulnerability/policy)' - name: Workload description: '' - name: WorkloadAccountSetting description: Workload Account Setting - name: WorkloadChangeMonitoring description: '' - name: WorkloadImageAssurance description: Workload Image Assurance - name: WorkloadImageAssuranceInternal description: '' - name: WorkloadInternal description: '' - name: WorkloadRuntimeProtection description: '' - name: Alerts description: '' - name: Azure description: '' - name: FindingOrchestration description: '' - name: FindingsUpdate description: '' - name: Gcp description: '' - name: Remediation description: Remediation Actions - name: Reports description: '' - name: CloudInfraMigration description: infinity-portal-connect - name: GslBuilder description: '' - name: Infrastructure description: '' - name: InternalLicense description: '' - name: NotificationIntegrationInternal description: '(deprecated: This controller is deprecated and will be removed in the future)' - name: OciCloudAccount description: Onboard OCI accounts - name: PlatformReports description: '' - name: Regions description: '' - name: Spectral description: '' - name: RestrictedWorkloadClientModules description: '' - name: WorkloadClientModules description: '' - name: WorkloadTelemetry description: '' - name: Integration description: Integration - name: IntegrationInternal description: '' - name: Notification description: Notification - name: NotificationInternal description: '' - name: AssetMetadataSyncNow description: '' - name: BusinessPriorityModifier description: Business Priority Rules - name: CustomRuleset description: Risk Management Rulesets - name: Dspm description: DSPM Controller - name: Exposure description: '' - name: GroupRiskManagement description: Groups Risk Management - name: RemediationActions description: Remediation Actions - name: RiskModifiers description: Risk Modifiers - name: SecurityEvents description: '' - name: SimilarAssetGroups description: '' - name: Waf description: WAF Protection - name: AwsOrganizationManagement description: AwsOrganizationManagement - name: AwsOrganizationManagementOnboarding description: AwsOrganizationManagementOnboarding - name: AzureOrganizationManagement description: AzureOrganizationManagement - name: GcpOrganizationManagement description: GcpOrganizationManagement - name: OnboardingManagement description: OnboardingManagement - name: InternalSBOM description: '' - name: InternalVulnerabilityAccountStatsBatch description: '' - name: InternalVulnerabilityCleanup description: '' - name: InternalVulnerabilityPolicy description: '' - name: InternalVulnerabilityScanResults description: '' - name: SBOM description: '' - name: SBOMExport description: SBOM Export - name: Vulnerabilities description: Vulnerabilities - name: VulnerabilityAssessment description: '' - name: VulnerabilityExclusions description: Vulnerability Exclusions - name: VulnerabilityPolicy description: Vulnerability Policy - name: VulnerabilitySBOM description: '' - name: CloudApplicationLoadBalancer description: '' - name: CloudNetworkLoadBalancer description: '' - name: GcpMachineImage description: '' - name: OciCompartment description: '' - name: AssetLabelsService description: '' - name: AssetOpenFindings description: '' - name: EntityTypes description: The entity types endpoint allows you to get the supported entity types and the platform they're supported for. - name: EvidencePath description: The evidence path endpoint allows you to get the evidence path for a given findingId. - name: Exclusions description: The exclusion endpoint provides API to perform CRUD operations on the resource. - name: IgnoreCves description: The ignore CVEs endpoint provides API to perform CRUD operations on the resource. - name: IgnoreMalwares description: The ignore malwares endpoint provides API to perform CRUD operations on the resource. - name: Rules description: The rules endpoint provides APIs to get the security rules data - name: SecurityGraphIssues description: API for issue enrichments - name: SecurityGraphQuery description: The query endpoint provides APIs to run queries (rules) to preview possible issues. - name: EntitySchema description: The entity schema endpoint presents schema of toxic issues entities. - name: SecurityIssues description: The Findings endpoint provides APIs query the findings store which contains findings such as security issues. It provides APIs to get, search and group findings. - name: AutomatedActions description: The Automated Actions resource provides API to perform CRUD operations on the resource. components: schemas: Dome9.Web.Api.Alibaba.Accounts.AlibabaAccountStatsViewModel: type: object properties: cloudAccountId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string creationDate: format: date-time type: string alibabaAccountId: type: string organizationalUnitId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 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 Dome9.Web.Api.Shared.Permissions.CloudAccountMissingPermissionsViewModel: type: object properties: id: format: uuid description: account id type: string example: 00000000-0000-0000-0000-000000000000 actions: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.CloudAccountExternalActionStatusViewModel' Dome9.Web.Api.Shared.Permissions.CloudAccountExternalActionStatusViewModel: type: object properties: type: type: string subType: type: string total: format: int64 type: integer error: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.CloudAccountActionFailureViewModel' Dome9.Web.Api.Shared.Permissions.CloudAccountActionFailureViewModel: type: object properties: code: type: string message: type: string Dome9.Web.Api.Shared.Permissions.CloudAccountMissingPermissionsIgnorableViewModel: type: object properties: id: format: uuid description: account id type: string example: 00000000-0000-0000-0000-000000000000 actions: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.MissingPermissionsIgnorableViewModel' Dome9.Web.Api.Shared.Permissions.MissingPermissionsIgnorableViewModel: type: object properties: permissionId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 isIgnored: type: boolean type: type: string subType: type: string total: format: int64 type: integer error: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.CloudAccountActionFailureViewModel' Dome9.Web.Api.Shared.Permissions.MissingPermissionsIgnorableUpdateViewModel: required: - isIgnored type: object properties: cloudAccountId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 permissionId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 isIgnored: type: boolean type: type: string subType: type: string errorCode: type: string errorMessage: type: string Dome9.Web.Api.Shared.Permissions.MissingPermissionViewModel: type: object properties: srl: description: internal use type: string consecutiveFails: format: int32 description: number of consecutive failures due to missing permissions type: integer lastFail: format: date-time description: time of last failure type: string lastSuccess: format: date-time description: time of last successful attempt type: string firstFail: format: date-time description: time of first successful attempt type: string lastFailErrorCode: description: error code for last failed attempt type: string lastFailMessage: description: error message for last failed attempt type: string id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 retryMetadata: $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.MissingPermissionMetadataViewModel' cloudAccountId: format: uuid description: Cloud account id type: string example: 00000000-0000-0000-0000-000000000000 vendor: description: cloud account provider (AWS, Azure, GCP) 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 Dome9.Web.Api.Shared.Permissions.MissingPermissionMetadataViewModel: type: object properties: permissions: description: list of missing permissions type: array items: type: string entityType: type: string subType: type: string Dome9.Web.Api.Alibaba.Accounts.AlibabaAccountNameViewModel: type: object properties: name: type: string Dome9.Web.Api.Alibaba.Accounts.AlibabaCloudAccountGetViewModel: required: - credentials type: object properties: id: format: uuid description: Alibaba id type: string example: 00000000-0000-0000-0000-000000000000 name: description: Alibaba account name in Dome9 type: string creationDate: format: date-time description: creation date for project in Alibaba type: string alibabaAccountId: description: the Alibaba account id (that will be onboarded) type: string credentials: $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaAccountCredentialsViewGetModel' description: ALibaba account credentials 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 Dome9.Web.Api.Alibaba.Accounts.AlibabaAccountCredentialsViewGetModel: required: - accessKey type: object properties: accessKey: description: Alibaba access key type: string Dome9.Web.Api.Alibaba.Accounts.AlibabaAccountCredentialsViewPostModel: required: - accessKey - accessSecret type: object properties: accessKey: description: Alibaba access key type: string accessSecret: description: Password for account type: string Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel: type: object properties: organizationalUnitId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 Dome9.BL.Std.Services.OrganizationalUnit.MoveOrganizationalUnitViewModel: type: object properties: sourceOrganizationalUnitId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 targetOrganizationalUnitId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 Dome9.BL.Std.Services.OrganizationalUnit.AttachCloudAccountsViewModel: type: object properties: entries: type: array items: type: string organizationalUnitId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 Dome9.Web.Api.Alibaba.Accounts.AlibabaCloudAccountPostViewModel: required: - name - credentials type: object properties: name: type: string credentials: $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaAccountCredentialsViewPostModel' organizationalUnitId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 Dome9.Web.Api.Models.CloudAccountRegionConfigurationViewModel: type: object properties: region: description: '[Required] Dome9 representation value for the AWS region' enum: - us_east_1 - us_west_1 - eu_west_1 - ap_southeast_1 - ap_northeast_1 - us_west_2 - sa_east_1 - az_1_region_a_geo_1 - az_2_region_a_geo_1 - az_3_region_a_geo_1 - ap_southeast_2 - mellanox_region - us_gov_west_1 - eu_central_1 - ap_northeast_2 - ap_south_1 - us_east_2 - ca_central_1 - eu_west_2 - eu_west_3 - eu_north_1 - cn_north_1 - cn_northwest_1 - us_gov_east_1 - ap_east_1 - me_south_1 - af_south_1 - eu_south_1 - ap_northeast_3 - me_central_1 - ap_south_2 - ap_southeast_3 - ap_southeast_4 - eu_central_2 - eu_south_2 - il_central_1 - ca_west_1 - mx_central_1 - ap_southeast_5 - ap_southeast_7 - westus - eastus - eastus2 - northcentralus - westus2 - southcentralus - centralus - usgovlowa - usgovvirginia - northeurope - westeurope - eastasia - southeastasia - japaneast - japanwest - brazilsouth - australiaeast - australiasoutheast - centralindia - southindia - westindia - canadaeast - westcentralus - chinaeast - chinanorth - canadacentral - germanycentral - germanynortheast - koreacentral - uksouth - ukwest - koreasouth - francecentral - francesouth - germanywestcentral - usdodcentral - usdodeast - usgovarizona - usgovtexas - australiacentral - australiacentral2 - chinaeast2 - chinanorth2 - southafricanorth - southafricawest - uaecentral - uaenorth - ussecwest - usseceast - germanynorth - switzerlandwest - norwaywest - norwayeast - switzerlandnorth - westus3 - swedencentral - chinanorth3 - brazilsoutheast - eastus2euap - jioindiawest - jioindiacentral - qatarcentral - spaincentral - italynorth - polandcentral - mexicocentral - asia - asia_east1 - asia_northeast1 - asia_south1 - asia_southeast1 - australia_southeast1 - europe - europe_north1 - europe_west1 - europe_west2 - europe_west3 - europe_west4 - northamerica_northeast1 - southamerica_east1 - us - us_central1 - us_east1 - us_east4 - us_west1 - us_west2 - global - asia_east2 - eur4 - nam4 - europe_west6 - japan_west - asia_northeast2 - asia_northeast3 - us_west3 - us_west4 - asia_southeast2 - nam3 - nam5 - nam6 - nam7 - nam10 - nam_eur_asia1 - eur3 - eur5 - asia1 - nam11 - eu - northamerica_northeast2 - southamerica_west1 - us_east5 - us_south1 - europe_central2 - europe_southwest1 - europe_west8 - europe_west9 - europe_west10 - europe_west12 - asia_south2 - australia_southeast2 - me_central1 - me_central2 - me_west1 - ap_sydney_1 - ap_melbourne_1 - sa_saopaulo_1 - sa_vinhedo_1 - ca_montreal_1 - ca_toronto_1 - sa_santiago_1 - eu_paris_1 - eu_marseille_1 - eu_frankfurt_1 - ap_hyderabad_1 - ap_mumbai_1 - il_jerusalem_1 - eu_milan_1 - ap_osaka_1 - ap_tokyo_1 - mx_queretaro_1 - eu_amsterdam_1 - me_jeddah_1 - ap_singapore_1 - af_johannesburg_1 - ap_seoul_1 - ap_chuncheon_1 - eu_madrid_1 - eu_stockholm_1 - eu_zurich_1 - me_abudhabi_1 - me_dubai_1 - uk_london_1 - uk_cardiff_1 - us_ashburn_1 - us_phoenix_1 - us_sanjose_1 - us_gov_ashburn_1 - us_gov_chicago_1 - us_gov_phoenix_1 - us_langley_1 - us_luke_1 - uk_gov_london_1 - uk_gov_cardiff_1 - sa_bogota_1 - us_chicago_1 - sa_valparaiso_1 - mx_monterrey_1 - eu_jovanovac_1 - ap_singapore_2 type: string name: description: '[Readonly] The region name' type: string hidden: description: '[Deprecated]' type: boolean newGroupBehavior: description: '[Required] The Protection Mode that Dome9 will apply to new security groups detected in the cloud account.
ReadOnly New Security Groups will be included in Dome9 in Read-Only mode, without changes to any of the rules
FullManage New Security Groups will be included in Dome9 in Full Protection mode, without changes to any of the rules
Reset New Security Groups will be included in Dome9 in Full Protection mode, and all inbound and outbound rules will be cleared' enum: - ReadOnly - FullManage - Reset type: string Dome9.Web.Api.Models.CloudAccountCredentialsViewModel: type: object properties: apikey: description: '[Deprecated]' type: string arn: description: '[Required] AWS Role ARN (to be assumed by Dome9 System)' type: string secret: description: '[Required] The AWS role External ID (Dome9 System will have to use this secret in order to assume the role)' type: string iamUser: description: '[Deprecated]' type: string type: description: '[Required] The cloud account onbiarding method. Should be set to "RoleBased" as other methods are deprecated' enum: - UserBased - RoleBased type: string isReadOnly: description: "[Readonly] The credential permission state.\r\nThis filed is determined based on the operation response\ \ status performed by Dome9 on the target AWS cloud account." type: boolean Dome9.Web.Api.Models.AwsSyncNowResultViewModel: type: object properties: cloudAccountId: format: uuid description: the AWS account id type: string example: 00000000-0000-0000-0000-000000000000 name: description: the account name type: string externalAccountNumber: description: the AWS external account number type: string workFlowId: format: uuid description: the AWS workflow id type: string example: 00000000-0000-0000-0000-000000000000 Dome9.Web.Api.Models.CloudAccountViewModel: type: object properties: id: format: uuid description: '[Readonly] The Dome9 id' type: string example: 00000000-0000-0000-0000-000000000000 vendor: description: '[Readonly] The cloud provider (AWS)' 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 name: description: The cloud account name type: string externalAccountNumber: description: '[Readonly] The AWS account number' type: string error: description: '[Readonly] credentials error status' type: string isFetchingSuspended: description: '[Readonly] fetching suspending status' type: boolean creationDate: format: date-time description: '[Readonly] account creation date' type: string credentials: $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountCredentialsViewModel' description: '[Required] The information needed for Dome9 System in order to connect to the AWS cloud account' iamSafe: $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountIamSafeViewModel' description: '[Readonly] The IamSafety configuration of the AWS cloud account' netSec: $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountNetSecViewModel' description: '[Readonly] The network security configuration for the AWS cloud account.' magellan: description: '[Readonly] Flag to determine if Magellan is enabled/disabled for the account' type: boolean fullProtection: description: "[Required] As part of the AWS account onboarding, the account security groups are imported. \r\nThis\ \ flag determines whether to enable Tamper Protection mode for those security groups." type: boolean allowReadOnly: description: "[Required] Determines the AWS cloud account operation mode.\r\nFor \"Manage\" set to true, for \"\ Readonly\" set to false." type: boolean organizationId: description: The unique identifier (ID) of an AWS organization. E.g. 9w9xc7rq7p type: string organizationalUnitId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 organizationalUnitPath: type: string organizationalUnitName: type: string lambdaScanner: description: Flag indicating if lambda scanner is enabled/disabled for the account type: boolean serverless: $ref: '#/components/schemas/Dome9.Web.Api.Models.SeverlessConfigViewModel' onboardingMode: enum: - Undefined - Legacy - CloudGuardManaged - CustomerManaged type: string Dome9.Web.Api.Models.CloudAccountIamSafeViewModel: type: object properties: awsGroupArn: type: string awsPolicyArn: type: string mode: enum: - OptIn - Mandatory type: string state: enum: - Enabled - Disabled type: string excludedIamEntities: $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountIamSafeIamEntitiesViewModel' restrictedIamEntities: $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountIamSafeIamEntitiesViewModel' Dome9.Web.Api.Models.CloudAccountNetSecViewModel: type: object properties: regions: description: List of network security configuration per AWS region type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountRegionConfigurationViewModel' Dome9.Web.Api.Models.SeverlessConfigViewModel: type: object properties: codeAnalyzerEnabled: type: boolean codeDependencyAnalyzerEnabled: type: boolean Dome9.Web.Api.Models.CloudAccountIamSafeIamEntitiesViewModel: type: object properties: rolesArns: type: array items: type: string usersArns: type: array items: type: string Dome9.Web.Api.Shared.SharedViewModels.TagViewModel: type: object properties: key: type: string value: type: string Dome9.Web.Api.Onboarding.Requests.OnboardingConfigurationRequest: type: object properties: onboardType: enum: - Simple - Advanced type: string fullProtection: type: boolean cloudVendor: 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 enableStackModify: type: boolean postureManagementConfiguration: $ref: '#/components/schemas/Falconetix.Model.Onboarding.PostureManagement.PostureManagementConfiguration' serverlessConfiguration: $ref: '#/components/schemas/Falconetix.Model.Onboarding.Serverless.ServerlessConfiguration' intelligenceConfigurations: $ref: '#/components/schemas/Falconetix.Model.Onboarding.Logic.IntelligenceConfigurations' Falconetix.Model.Onboarding.PostureManagement.PostureManagementConfiguration: type: object properties: rulesets: type: array items: format: int64 type: integer Falconetix.Model.Onboarding.Serverless.ServerlessConfiguration: type: object properties: enabled: type: boolean Falconetix.Model.Onboarding.Logic.IntelligenceConfigurations: type: object properties: enabled: type: boolean rulesets: type: array items: format: int64 type: integer Dome9.Web.Api.Onboarding.ViewModel.AwsStackConfigViewModel: type: object properties: stackName: type: string templateUrl: type: string parameters: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Onboarding.ViewModel.Parameter' iamCapabilities: type: array items: type: string Dome9.Web.Api.Onboarding.ViewModel.Parameter: type: object properties: key: type: string value: type: string Dome9.Web.Api.Onboarding.ViewModel.OnboardingInfoViewModel: type: object properties: onboardingId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 initiatedUserName: type: string initiatedUserId: format: int32 type: integer environmentId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 environmentName: type: string environmentExternalId: type: string rootStackId: type: string cftVersion: type: string onboardingRequest: $ref: '#/components/schemas/Dome9.Web.Api.Onboarding.Requests.OnboardingConfigurationRequest' statuses: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Onboarding.ViewModel.OnboardingStatus' intelligenceStackRegion: type: string Dome9.Web.Api.Onboarding.ViewModel.OnboardingStatus: type: object properties: module: type: string feature: type: string status: type: string statusMessage: type: string stackStatus: type: string stackMessage: type: string remediationRecommendation: type: string CGN.Common.Model.CloudAccounts.Onboarding.AzureSimplifiedOnboardingExecCmdRequest: required: - activeBlades type: object properties: workflowId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 subscriptionId: type: string managementGroupIdOrTenantId: type: string useCloudGuardManagedApp: type: boolean validatePermission: type: boolean appId: type: string appName: type: string appRegistrationId: type: string accountType: 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 activeBlades: $ref: '#/components/schemas/CGN.Common.Model.CloudAccounts.Onboarding.Blades.Blades' CGN.Common.Model.CloudAccounts.Onboarding.Blades.Blades: required: - awp - serverless - cdr - postureManagement type: object properties: awp: $ref: '#/components/schemas/CGN.Common.Model.CloudAccounts.Onboarding.Blades.AwpConfiguration' serverless: $ref: '#/components/schemas/CGN.Common.Model.CloudAccounts.Onboarding.Blades.ServerlessConfiguration' cdr: $ref: '#/components/schemas/CGN.Common.Model.CloudAccounts.Onboarding.Blades.CdrConfiguration' postureManagement: $ref: '#/components/schemas/CGN.Common.Model.CloudAccounts.Onboarding.Blades.PostureManagement' CGN.Common.Model.CloudAccounts.Onboarding.Blades.AwpConfiguration: type: object properties: onboardingMode: enum: - saas - inAccount - inAccountHub type: string centralizedSubscriptionId: type: string withFunctionAppsScan: type: boolean withSseCmkEncryptedDisksScan: type: boolean isEnabled: type: boolean CGN.Common.Model.CloudAccounts.Onboarding.Blades.ServerlessConfiguration: type: object properties: isEnabled: type: boolean CGN.Common.Model.CloudAccounts.Onboarding.Blades.CdrConfiguration: type: object properties: accounts: type: array items: $ref: '#/components/schemas/CGN.Common.Model.CloudAccounts.Onboarding.Blades.StorageAccount' isEnabled: type: boolean CGN.Common.Model.CloudAccounts.Onboarding.Blades.PostureManagement: type: object properties: onboardingMode: enum: - read-only - manage type: string CGN.Common.Model.CloudAccounts.Onboarding.Blades.StorageAccount: type: object properties: storageId: type: string logTypes: type: array items: type: string Dome9.Web.Api.Azure.Accounts.AzureAccountOperationModeViewModel: required: - operationMode type: object properties: operationMode: enum: - Read - Manage type: string 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 Dome9.Web.Api.Azure.Accounts.AzureAccountNameModeViewModel: type: object properties: name: type: string Dome9.Web.Api.Azure.Accounts.AzureCloudAccountCredentialsPutViewModel: required: - applicationId - applicationKey type: object properties: applicationId: type: string applicationKey: type: string Dome9.Web.Api.Google.Instance.GcpComputeAttachedDiskViewModel: type: object properties: autoDelete: type: boolean deviceName: type: string guestOsFeatures: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Google.Instance.GcpComputeGuestOsFeatureViewModel' eTag: type: string interface: type: string kind: type: string licenses: type: array items: type: string mode: type: string source: type: string type: type: string diskEncryptionType: type: string diskEncryptionTypeMetadata: $ref: '#/components/schemas/Dome9.Web.Api.Google.Instance.GcpComputeDiskEncryptionTypeMetadataViewModel' diskEncryptionKey: $ref: '#/components/schemas/Dome9.Web.Api.Google.Instance.GcpComputeInstanceCustomerEncryptionKeyViewModel' initializeParams: $ref: '#/components/schemas/Dome9.Web.Api.Google.Instance.GcpComputeAttachedDiskInitializeParamsViewModel' id: type: string Dome9.Web.Api.Google.Instance.GcpComputeGuestOsFeatureViewModel: type: object properties: type: type: string eTag: type: string Dome9.Web.Api.Google.Instance.GcpComputeDiskEncryptionTypeMetadataViewModel: type: object properties: isGoogleManagedKey: type: boolean readOnly: true isCustomerManagedKey: type: boolean readOnly: true isCustomerSuppliedKey: type: boolean readOnly: true Dome9.Web.Api.Google.Instance.GcpComputeInstanceCustomerEncryptionKeyViewModel: type: object properties: eTag: type: string rawKey: type: string sha256: type: string kmsKeyName: type: string Dome9.Web.Api.Google.Instance.GcpComputeAttachedDiskInitializeParamsViewModel: type: object properties: diskName: type: string diskSizeGb: format: int64 type: integer diskType: type: string sourceImage: type: string sourceImageEncryptionKey: $ref: '#/components/schemas/Dome9.Web.Api.Google.Instance.GcpComputeCustomerEncryptionKeyViewModel' eTag: type: string Dome9.Web.Api.Google.Instance.GcpComputeCustomerEncryptionKeyViewModel: type: object properties: kmsKeyName: type: string rawKey: type: string sha256: type: string eTag: type: string Dome9.Web.Api.Google.SecurityGroup.GcpSecurityGroupViewModel: type: object properties: network: type: string externalId: type: string inboundRules: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Google.SecurityGroup.GcpServiceRuleViewModel' outboundRules: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Google.SecurityGroup.GcpServiceRuleViewModel' vmInstances: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Google.Instance.GcpVMInstanceViewModel' id: type: string cloudAccountId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string Dome9.Web.Api.Google.SecurityGroup.GcpServiceRuleViewModel: type: object properties: name: type: string enabled: type: boolean description: type: string number: format: int32 type: integer protocol: type: string source: type: string destination: type: string destinationPort: format: int32 type: integer destinationPortTo: format: int32 type: integer direction: type: string action: type: string Dome9.Web.Api.Google.Instance.GcpVMInstanceViewModel: type: object properties: canIpForward: type: boolean cpuPlatform: type: string externalId: type: string creationTimestamp: type: string description: type: string disks: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Google.Instance.GcpComputeAttachedDiskViewModel' machineType: type: string sourceMachineImage: type: string networkInterfaces: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Google.Instance.NetworkInterfaceViewModel' status: type: string statusMessage: type: string networkTags: type: array items: type: string tags: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Shared.SharedViewModels.TagViewModel' labels: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Shared.SharedViewModels.TagViewModel' zone: type: string region: type: string isRunning: type: boolean readOnly: true isBillable: type: boolean readOnly: true id: type: string cloudAccountId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 name: type: string Dome9.Web.Api.Google.Instance.NetworkInterfaceViewModel: type: object properties: name: type: string network: type: string networkIP: type: string subnetwork: type: string publicIP: type: string Dome9.Web.Api.Google.Accounts.GoogleAccountOnboardingDetailsViewModel: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 projectId: type: string clientEmail: format: email description: Email Address type: string example: MyName@gmail.com domainName: type: string gSuitUser: type: string Dome9.Web.Api.Google.Accounts.GoogleAccountStatsViewModel: type: object properties: stats: type: array items: $ref: '#/components/schemas/Falconetix.Model.Google.NetworkStat' totalVMInstancesCount: format: int32 type: integer totalSecurityGroupsCount: format: int32 type: integer totalFirewallRulesCount: format: int32 type: integer networks: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Google.Network.GoogleCloudNetworkViewModel' securityGroups: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Google.SecurityGroup.GcpSecurityGroupViewModel' vmInstances: type: array items: $ref: '#/components/schemas/Dome9.Web.Api.Google.Instance.GcpVMInstanceViewModel' Falconetix.Model.Google.NetworkStat: type: object properties: networkId: type: string networkName: type: string resourceType: enum: - Local - Shared type: string vmInstancesCount: format: int32 type: integer securityGroupsCount: format: int32 type: integer firewallRulesCount: format: int32 type: integer Dome9.Web.Api.Google.Network.GoogleCloudNetworkViewModel: type: object properties: cloudAccountName: type: string autoCreateSubnetworks: type: boolean creationTimestamp: type: string description: type: string eTag: type: string gatewayIPv4: type: string iPv4Range: type: string kind: type: string name: type: string subnetworks: type: array items: type: string id: type: string cloudAccountId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 Dome9.Web.Api.Google.Accounts.GoogleAccountNameViewModel: type: object properties: name: type: string Dome9.Web.Api.Google.Accounts.GoogleCloudAccountGetViewModel: type: object properties: id: format: uuid description: Google id type: string example: 00000000-0000-0000-0000-000000000000 name: description: Google account name in Dome9 type: string projectId: description: the Google project id (that will be onboarded) type: string creationDate: format: date-time description: creation date for project in Google type: string organizationalUnitId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 organizationalUnitPath: type: string organizationalUnitName: type: string gsuite: $ref: '#/components/schemas/Dome9.Web.Api.Google.Accounts.GoogleAccountGsuiteViewModel' 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 projectNumber: type: string clientEmail: format: email description: Email Address type: string example: MyName@gmail.com Dome9.Web.Api.Google.Accounts.GoogleAccountGsuiteViewModel: type: object properties: gsuiteUser: type: string domainName: type: string Dome9.Web.Api.Google.Accounts.GoogleCloudAccountUpdateViewModel: required: - name - serviceAccountCredentials type: object properties: name: description: Google account name in Dome9 type: string serviceAccountCredentials: description: The service account JSON block (from the GCP console) type: object Dome9.Web.Api.Google.Accounts.GoogleCloudAccountPostViewModel: required: - name - serviceAccountCredentials type: object properties: name: description: Google account name in Dome9 type: string serviceAccountCredentials: description: The service account JSON block (from the GCP console) type: object organizationalUnitId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 gsuiteUser: type: string domainName: type: string Dome9.Web.Api.Models.CloudAccountPartialUpdateViewModel_System.String_: type: object properties: cloudAccountId: format: uuid description: 'The Dome9 cloud account id, at least one of the following properties must be provided: "cloudAccountId", "externalAccountNumber"' type: string example: 00000000-0000-0000-0000-000000000000 externalAccountNumber: description: 'Aws external account number, at least one of the following properties must be provided: "cloudAccountId", "externalAccountNumber"' type: string data: type: string Dome9.Web.Api.Models.CloudAccountPartialUpdateViewModel_Dome9.Web.Api.Models.CloudAccountRegionConfigurationViewModel_: type: object properties: cloudAccountId: format: uuid description: 'The Dome9 cloud account id, at least one of the following properties must be provided: "cloudAccountId", "externalAccountNumber"' type: string example: 00000000-0000-0000-0000-000000000000 externalAccountNumber: description: 'Aws external account number, at least one of the following properties must be provided: "cloudAccountId", "externalAccountNumber"' type: string data: $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountRegionConfigurationViewModel' Dome9.Web.Api.Models.CloudAccountPartialUpdateViewModel_Dome9.Web.Api.Models.CloudAccountCredentialsViewModel_: type: object properties: cloudAccountId: format: uuid description: 'The Dome9 cloud account id, at least one of the following properties must be provided: "cloudAccountId", "externalAccountNumber"' type: string example: 00000000-0000-0000-0000-000000000000 externalAccountNumber: description: 'Aws external account number, at least one of the following properties must be provided: "cloudAccountId", "externalAccountNumber"' type: string data: $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountCredentialsViewModel' KubernetesAccountViewModel: type: object additionalProperties: false required: - id - externalAccountNumber - threatIntelligenceEnabled - imageAssuranceEnabled - imageAccessRuntimeMonitorEnabled - runtimeProtectionEnabled - runtimeProtectionNetwork - runtimeProtectionProfiling - runtimeProtectionFileReputation - admissionControlEnabled - admissionControlFailOpen - name - creationDate - vendor - organizationalUnitId - organizationalUnitPath - organizationalUnitName - clusterVersion - clusterVersionStatus - clusterVersionStatusDescription - description - platform - type properties: id: type: string description: Kubernetes id format: guid externalAccountNumber: type: string description: Kubernetes id threatIntelligenceEnabled: type: boolean description: Flag to determine if Threat Intelligence is enabled/disabled for the account imageAssuranceEnabled: type: boolean description: Flag to determine if Image Assurance is enabled/disabled for the account imageAccessRuntimeMonitorEnabled: type: boolean description: Flag to determine if Image Access Runtime Monitor is enabled/disabled for the account runtimeProtectionEnabled: type: boolean description: Flag to determine if Runtime Protection is enabled/disabled for the account runtimeProtectionNetwork: type: boolean description: Flag to determine if Runtime Protection Network protection is enabled/disabled for the account runtimeProtectionProfiling: type: boolean runtimeProtectionFileReputation: type: boolean admissionControlEnabled: type: boolean description: Flag to determine if Admission Control is enabled/disabled for the account admissionControlFailOpen: type: boolean description: Flag to determine if Admission control FailOpen is true/false for the account name: type: string description: Kubernetes account name in Dome9 creationDate: type: string description: creation date for project in Kubernetes format: date-time vendor: $ref: '#/components/schemas/CloudVendor' organizationalUnitId: type: string format: guid nullable: true organizationalUnitPath: type: string organizationalUnitName: type: string clusterVersion: type: string clusterVersionStatus: type: string clusterVersionStatusDescription: type: string description: type: string nullable: true platform: $ref: '#/components/schemas/CloudVendor' type: $ref: '#/components/schemas/KubernetesPlatformType' CloudVendor: type: string description: '' x-enumNames: - aws - hp - mellanox - awsgov - azure - google - awschina - azuregov - kubernetes - azurechina - terraform - generic - kubernetesruntimeassurance - shiftleft - sourcecodeassurance - imageassurance - alibaba - cft - containerregistry - oci - ocigov - ocigovuk - CIEM enum: - aws - hp - mellanox - awsgov - azure - google - awschina - azuregov - kubernetes - azurechina - terraform - generic - kubernetesruntimeassurance - shiftleft - sourcecodeassurance - imageassurance - alibaba - cft - containerregistry - oci - ocigov - ocigovuk - CIEM KubernetesPlatformType: type: string description: '' x-enumNames: - NA - GKE - EKS - AKS - Openshift enum: - NA - GKE - EKS - AKS - Openshift KubernetesPostViewModel: type: object additionalProperties: false required: - name - organizationalUnitId - description properties: name: type: string description: Kubernetes account name in Dome9 maxLength: 500 pattern: ^[\p{L}\p{M}0-9\s\-_'.,#/@;:!=]*$ organizationalUnitId: type: string description: Kubernetes account name in Dome9 format: guid nullable: true description: type: string description: Kubernetes account description in CloudGuard maxLength: 1000 pattern: ^[\p{L}\p{M}0-9\s\-_'.,#/@;:!=]*$ nullable: true KubernetesAccountSummaryViewModel: type: object additionalProperties: false required: - id - name - numberOfNodes - numberOfPods - numberOfServices - clusterVersion - agentsStatus - agentsStatusDescription - agentsStatusSuportUrl - featureStatuses - isAutoUpgradeActive - description properties: id: type: string description: Kubernetes id format: guid name: type: string description: Kubernetes account name in Dome9 numberOfNodes: type: integer description: Total Number of Nodes in the Kubernetes account format: int32 numberOfPods: type: integer description: Total Number of Pods in the Kubernetes account format: int32 numberOfServices: type: integer description: Total Number of Services in the Kubernetes account format: int32 clusterVersion: type: string description: Kubernetes cluster server version agentsStatus: type: string description: Kubernetes cluster agent version agentsStatusDescription: type: string description: Kubernetes cluster agents status description agentsStatusSuportUrl: type: string description: Kubernetes cluster agents status support URL featureStatuses: type: array description: Kubernetes cluster agent feature status list items: $ref: '#/components/schemas/KubernetesAccountFeatureAgentStatusViewModel' isAutoUpgradeActive: type: boolean description: type: string description: Kubernetes cluster description KubernetesAccountFeatureAgentStatusViewModel: type: object additionalProperties: false required: - kubernetesFeature - statusOk - statusError - statusInit - statusPending properties: kubernetesFeature: type: string description: Feature statusOk: type: integer description: Status Ok format: int32 statusError: type: integer description: Status Error format: int32 statusInit: type: integer description: Status Init format: int32 statusPending: type: integer description: Status Pending format: int32 KubernetesAccountAgentStatusViewModel: type: object additionalProperties: false required: - id - agentsStatus - agentsStatusDescription - agentsStatusSupportUrl - admissionControlEnabled - imageAssuranceEnabled - runtimeProtectionEnabled - threatIntelligenceEnabled - features properties: id: type: string description: Kubernetes account id format: guid agentsStatus: type: string description: Kubernetes cluster agent status agentsStatusDescription: type: string description: Kubernetes cluster agent status description agentsStatusSupportUrl: type: string description: Kubernetes cluster agent status support URL admissionControlEnabled: type: boolean description: Kubernetes AdmissionControl Enabled imageAssuranceEnabled: type: boolean description: Kubernetes ImageAssurance Enabled runtimeProtectionEnabled: type: boolean description: Kubernetes RuntimeProtection Enabled threatIntelligenceEnabled: type: boolean description: Kubernetes ThreatIntelligence Enabled features: type: array description: Kubernetes account features status items: $ref: '#/components/schemas/KubernetesAccountFeatureSummaryViewModel' KubernetesAccountFeatureSummaryViewModel: type: object additionalProperties: false required: - name - status - statusDescription properties: name: type: string status: $ref: '#/components/schemas/KubernetesAgentStatusOptions' statusDescription: type: string KubernetesAgentStatusOptions: type: string description: '' x-enumNames: - OK - INITIALIZING - PENDING_CLEANUP - PENDING - WARNING - ERROR - DISABLED enum: - OK - INITIALIZING - PENDING_CLEANUP - PENDING - WARNING - ERROR - DISABLED KubernetesAccountAgentStatusFiltersViewModel: type: object additionalProperties: false required: - statuses - isAgentUpToDate - organizationalUnitIds properties: statuses: type: array description: Filter agents by status (OK/WARNING/ERROR/PENDING/PENDING_CLEANUP/INITIALIZING/DISABLED). nullable: true items: $ref: '#/components/schemas/KubernetesAgentStatusOptions' isAgentUpToDate: type: boolean description: Filter agents that are up to date or not. Set to 'null' to include all. nullable: true organizationalUnitIds: type: array description: Filter agents by the organizational unit. nullable: true items: type: string format: guid KubernetesAgentsSummaryViewModel: type: object additionalProperties: false required: - agentType - agentSummary properties: agentType: type: string agentSummary: type: array items: $ref: '#/components/schemas/KubernetesAgentSummaryViewModel' KubernetesAgentSummaryViewModel: type: object additionalProperties: false required: - version - isAgentUpToDate - lastCommunication - lastCommunicationDate - status - description - supportUrl - nodeName - creationTime - creationDate - agentIdentifier - components properties: version: type: string isAgentUpToDate: type: boolean lastCommunication: type: string deprecated: true x-deprecatedMessage: use LastCommunicationDate lastCommunicationDate: type: string format: date-time nullable: true status: type: string description: type: string supportUrl: type: string nodeName: type: string creationTime: type: string deprecated: true x-deprecatedMessage: use CreationDate creationDate: type: string format: date-time nullable: true agentIdentifier: type: string components: type: array items: $ref: '#/components/schemas/KubernetesAgentComponentViewModel' KubernetesAgentComponentViewModel: type: object additionalProperties: false required: - lastOkTime - lastOkDate - id - name - status - description - supportUrl - activationTime - activationDate properties: lastOkTime: type: string deprecated: true x-deprecatedMessage: use LastOkDate lastOkDate: type: string format: date-time nullable: true id: type: string name: type: string status: type: string description: type: string supportUrl: type: string activationTime: type: string deprecated: true x-deprecatedMessage: use ActivationDate activationDate: type: string format: date-time nullable: true UpdateIdViewModel: type: object additionalProperties: false required: - organizationalUnitId properties: organizationalUnitId: type: string format: guid nullable: true MoveOrganizationalUnitViewModel: type: object additionalProperties: false required: - sourceOrganizationalUnitId - targetOrganizationalUnitId properties: sourceOrganizationalUnitId: type: string format: guid nullable: true targetOrganizationalUnitId: type: string format: guid nullable: true AttachCloudAccountsViewModel: type: object additionalProperties: false required: - entries - organizationalUnitId properties: entries: type: array default: [] nullable: true items: type: string organizationalUnitId: type: string format: guid nullable: true ContainerRegistryAccountViewModel: type: object additionalProperties: false required: - id - creationDate - organizationalUnitPath - organizationalUnitName - name - registryUrl - organizationalUnitId - linkedKubernetesEnvironments - linkedScanningEnvironments - description - platform - type properties: id: type: string format: guid creationDate: type: string format: date-time organizationalUnitPath: type: string organizationalUnitName: type: string name: type: string registryUrl: type: string organizationalUnitId: type: string format: guid nullable: true linkedKubernetesEnvironments: type: array items: $ref: '#/components/schemas/ContainerRegistryLinkedEnvironmentViewModel' linkedScanningEnvironments: type: array items: $ref: '#/components/schemas/ContainerRegistryLinkedEnvironmentViewModel' description: type: string nullable: true platform: $ref: '#/components/schemas/CloudVendor' type: $ref: '#/components/schemas/ContainerRegistryType' ContainerRegistryLinkedEnvironmentViewModel: type: object additionalProperties: false required: - environmentId - pullSecretName - tenantId - applicationClientId - scanningEnvironmentType - registryAuthType - roleArn properties: environmentId: type: string format: guid minLength: 1 pullSecretName: type: string pattern: ^(?=.{1,253}$)[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ nullable: true tenantId: type: string nullable: true applicationClientId: type: string nullable: true scanningEnvironmentType: nullable: true oneOf: - $ref: '#/components/schemas/ContainerRegistryScanningEnvironmentType' registryAuthType: nullable: true oneOf: - $ref: '#/components/schemas/ContainerRegistryAuthType' roleArn: type: string pattern: ^arn:aws:iam::\d{12}:role/[\w+=,.@-]+ nullable: true ContainerRegistryScanningEnvironmentType: type: string description: '' x-enumNames: - AWS - Kubernetes enum: - AWS - Kubernetes ContainerRegistryAuthType: type: string description: '' x-enumNames: - AcrServicePrincipal - AcrManagedId - EcrUserAccessKeys - EcrNodeGroupRole - GcpServiceAccountKey - GcpGkeInternalAuth - ArtifactoryUserPassword - ArtifactoryToken - HarborUserPassword - EcrCustomRole - NexusUserPassword - EcrEcsTaskRole - GithubToken - QuayToken - DockerhubToken enum: - AcrServicePrincipal - AcrManagedId - EcrUserAccessKeys - EcrNodeGroupRole - GcpServiceAccountKey - GcpGkeInternalAuth - ArtifactoryUserPassword - ArtifactoryToken - HarborUserPassword - EcrCustomRole - NexusUserPassword - EcrEcsTaskRole - GithubToken - QuayToken - DockerhubToken ContainerRegistryType: type: string description: '' x-enumNames: - ACR - ECR - GCR - GAR - Artifactory - Harbor - Nexus - GitHub - Quay - DockerHub enum: - ACR - ECR - GCR - GAR - Artifactory - Harbor - Nexus - GitHub - Quay - DockerHub ContainerRegistryAccountPostModel: type: object additionalProperties: false required: - name - registryType - registryUrl - description - organizationalUnitId - linkedKubernetesEnvironments - linkedScanningEnvironments properties: name: type: string maxLength: 500 minLength: 1 pattern: ^[\p{L}\p{M}0-9\s\-_'.,#/@;:!=]*$ description: type: string description: " Container Registry environment description in CloudGuard\t\n " maxLength: 1000 pattern: ^[\p{L}\p{M}0-9\s\-_'.,#/@;:!=]*$ nullable: true organizationalUnitId: type: string format: guid nullable: true registryType: $ref: '#/components/schemas/ContainerRegistryType' registryUrl: type: string format: uri minLength: 1 linkedKubernetesEnvironments: type: array description: Deprecated - please use 'LinkedScanningEnvironments' nullable: true items: $ref: '#/components/schemas/ContainerRegistryLinkedEnvironmentViewModel' linkedScanningEnvironments: type: array nullable: true items: $ref: '#/components/schemas/ContainerRegistryLinkedEnvironmentViewModel' ContainerRegistryUserConfigurationsViewModel: type: object additionalProperties: false required: - imageListIntervalSeconds - maxImagesPerRepo - maxImagesPerBaseRepo properties: imageListIntervalSeconds: type: integer format: int32 nullable: true maxImagesPerRepo: type: integer format: int32 nullable: true maxImagesPerBaseRepo: type: integer format: int32 nullable: true ContainerRegistryAgentSummaryViewModel: type: object additionalProperties: false required: - version - isAgentUpToDate - lastCommunication - lastCommunicationDate - status - description - supportUrl - creationTime - creationDate - kubernetesAccountId - kubernetesAccountName properties: version: type: string isAgentUpToDate: type: boolean lastCommunication: type: string deprecated: true x-deprecatedMessage: use LastCommunicationDate lastCommunicationDate: type: string format: date-time nullable: true status: type: string description: type: string supportUrl: type: string creationTime: type: string deprecated: true x-deprecatedMessage: use CreationDate creationDate: type: string format: date-time nullable: true kubernetesAccountId: type: string kubernetesAccountName: type: string ContainerRegistryAccountAgentSummaryViewModel: type: object additionalProperties: false required: - id - name - agentsStatus - agentsStatusDescription properties: id: type: string format: guid name: type: string agentsStatus: type: string agentsStatusDescription: type: string ContainerRegistryAccountSummaryViewModel: type: object additionalProperties: false required: - id - name - agentsStatus - agentsStatusDescription - registryType - registryUrl - numberOfImages - numberOfRepositories - linkedAgentsStatuses properties: id: type: string format: guid name: type: string agentsStatus: type: string agentsStatusDescription: type: string registryType: type: string registryUrl: type: string numberOfImages: type: integer format: int32 numberOfRepositories: type: integer format: int64 linkedAgentsStatuses: $ref: '#/components/schemas/ContainerRegistryLinkedAgentsStatusesViewModel' ContainerRegistryLinkedAgentsStatusesViewModel: type: object additionalProperties: false required: - statusOk - statusError - statusPending properties: statusOk: type: integer format: int32 statusError: type: integer format: int32 statusPending: type: integer format: int32 OciCloudAccountViewModel: type: object additionalProperties: false required: - credentials - id - name - creationDate - tenancyId - homeRegion - organizationalUnitId - organizationalUnitPath - organizationalUnitName - vendor properties: id: type: string description: OCI cloud account ID in CloudGuard format: guid name: type: string description: OCI account name in CloudGuard nullable: true creationDate: type: string description: Creation date for this cloud account ID in CloudGuard format: date-time tenancyId: type: string description: OCI TenancyId nullable: true homeRegion: type: string description: OCI account HomeRegion nullable: true credentials: description: OCI account Credentials details (user ocid, fingerprint, public key) oneOf: - $ref: '#/components/schemas/OciAccountCredentialsViewModel' organizationalUnitId: type: string format: guid nullable: true organizationalUnitPath: type: string nullable: true organizationalUnitName: type: string nullable: true vendor: $ref: '#/components/schemas/CloudVendor' OciAccountCredentialsViewModel: type: object additionalProperties: false required: - user - fingerprint - publicKey properties: user: type: string description: OCI user ocid. minLength: 1 fingerprint: type: string description: Hash of the public key. minLength: 1 publicKey: type: string description: The public key that should be used in OCI "identity api key". minLength: 1 OciCloudAccountTempDataCreationModel: type: object additionalProperties: false required: - name - tenancyId - homeRegion - tenantAdministratorEmailAddress - userName - groupName - policyName properties: name: type: string description: OCI account name in CloudGuard (The desired display name for the Tenancy) minLength: 1 tenancyId: type: string description: OCI TenancyId - that will be onboarded (found in OCI under ‘Profile’ -> ‘Tenancy’ -> ‘OCID’) minLength: 1 homeRegion: type: string description: 'The Tenancy’s Home Region Identifier (found in OCI by clicking the Regions dropdown at the top right corner). You can find the regions identifiers here: https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm' minLength: 1 tenantAdministratorEmailAddress: type: string description: 'OCI tenant administrator Email address, Email Address will be used to create a user that will have terraform attached policy. A Verification Email will be sent from OCI to the this Email address, and this user will be added to OCI account. For old OCI accounts this field will not be used.' minLength: 1 userName: type: string description: (*Optional) - The desired name for the User that will be created in the Tenancy (default - “CloudGuard-User”) nullable: true groupName: type: string description: (*Optional) - The desired name for the Group that will be created in the Tenancy (default - “CloudGuard-Group”) nullable: true policyName: type: string description: (*Optional) - The desired name for the Policy that will be created in the Tenancy (default - “CloudGuard-Policy”) nullable: true OciAccountCreationInput: type: object additionalProperties: false required: - userOcid - tenancyId - organizationalUnitId properties: userOcid: type: string description: The created user’s OCID (from the terraform output) minLength: 1 tenancyId: type: string description: The tenancy’s OCID (from the previous step) minLength: 1 organizationalUnitId: type: string description: The organizationalUnitId to add this cloud account to, or an empty GUID – “00000000-0000-0000-0000-000000000000” format: guid nullable: true OciAccountNameViewModel: type: object additionalProperties: false required: - name properties: name: type: string minLength: 1 CloudAccountMissingPermissionsViewModel: type: object additionalProperties: false required: - accountId - actions properties: accountId: type: string format: guid actions: type: array nullable: true items: $ref: '#/components/schemas/CloudAccountExternalActionStatusViewModel' CloudAccountExternalActionStatusViewModel: type: object additionalProperties: false required: - type - subType - total - error properties: type: type: string nullable: true subType: type: string nullable: true total: type: integer format: int64 nullable: true error: nullable: true oneOf: - $ref: '#/components/schemas/CloudAccountActionFailureViewModel' CloudAccountActionFailureViewModel: type: object additionalProperties: false required: - code - message properties: code: type: string nullable: true message: type: string nullable: true CloudAccountMissingPermissionsIgnorableViewModel: type: object additionalProperties: false required: - id - actions properties: id: type: string description: account id format: guid actions: type: array nullable: true items: $ref: '#/components/schemas/MissingPermissionsIgnorableViewModel' MissingPermissionsIgnorableViewModel: allOf: - $ref: '#/components/schemas/CloudAccountExternalActionStatusViewModel' - type: object additionalProperties: false required: - permissionId - isIgnored properties: permissionId: type: string format: guid nullable: true isIgnored: type: boolean nullable: true MissingPermissionsIgnorableUpdateViewModel: type: object additionalProperties: false required: - isIgnored - cloudAccountId - permissionId - type - subType - errorCode - errorMessage properties: cloudAccountId: type: string format: guid permissionId: type: string format: guid nullable: true isIgnored: type: boolean type: type: string nullable: true subType: type: string nullable: true errorCode: type: string nullable: true errorMessage: type: string nullable: true MissingPermissionViewModel: type: object additionalProperties: false required: - srl - consecutiveFails - lastFail - lastSuccess - firstFail - lastFailErrorCode - lastFailMessage - id - retryMetadata - cloudAccountId - vendor properties: srl: type: string description: for internal use nullable: true consecutiveFails: type: integer description: number of consecutive failures due to missing permissions format: int32 lastFail: type: string description: time of last failure format: date-time nullable: true lastSuccess: type: string description: time of last successful attempt format: date-time nullable: true firstFail: type: string description: time of first successful attempt format: date-time nullable: true lastFailErrorCode: type: string description: error code for last failed attempt nullable: true lastFailMessage: type: string description: error message for last failed attempt nullable: true id: type: string format: guid retryMetadata: nullable: true oneOf: - $ref: '#/components/schemas/MissingPermissionMetadataViewModel' cloudAccountId: type: string description: Cloud account id format: guid vendor: description: cloud account provider (AWS, Azure, GCP) oneOf: - $ref: '#/components/schemas/CloudVendor' MissingPermissionMetadataViewModel: type: object additionalProperties: false required: - missingPermissions - entityType - subType properties: missingPermissions: type: array nullable: true items: type: string entityType: type: string nullable: true subType: type: string nullable: true OrganizationManagementViewModel: type: object additionalProperties: false required: - id - accountId - externalOrganizationId - externalManagementAccountId - managementAccountStackId - managementAccountStackRegion - onboardingConfiguration - managedAccounts - userId - enableStackModify - stackSetArn - organizationName - updateTime - creationTime - stackSetRegions - stackSetOrganizationalUnitIds properties: id: type: string format: guid accountId: type: integer format: int64 externalOrganizationId: type: string externalManagementAccountId: type: string managementAccountStackId: type: string managementAccountStackRegion: type: string onboardingConfiguration: $ref: '#/components/schemas/AwsOrganizationOnboardingConfiguration' managedAccounts: type: array items: type: string userId: type: integer format: int32 enableStackModify: type: boolean stackSetArn: type: string organizationName: type: string updateTime: type: string format: date-time creationTime: type: string format: date-time stackSetRegions: type: array description: A list of all Amazon Web Services Regions the given StackSet has stack instances deployed in. items: type: string stackSetOrganizationalUnitIds: type: array description: The organization root ID or organizational unit (OU) IDs that the client specified for the StackSet DeploymentTargets. items: type: string AwsOrganizationOnboardingConfiguration: allOf: - $ref: '#/components/schemas/OrganizationOnboardingConfigurationBase' - type: object additionalProperties: false OrganizationOnboardingConfigurationBase: type: object additionalProperties: false required: - organizationRootOuId - mappingStrategy - postureManagement properties: organizationRootOuId: type: string format: guid nullable: true mappingStrategy: $ref: '#/components/schemas/MappingStrategyType' postureManagement: nullable: true oneOf: - $ref: '#/components/schemas/PostureManagementConfiguration' MappingStrategyType: type: string description: '' x-enumNames: - Flat - Clone enum: - Flat - Clone PostureManagementConfiguration: type: object additionalProperties: false required: - rulesetsIds - onboardingMode properties: rulesetsIds: type: array default: [] nullable: true items: type: integer format: int64 onboardingMode: $ref: '#/components/schemas/OnboardingMode' OnboardingMode: type: string description: '' x-enumNames: - Read - Manage enum: - read-only - manage OnboardingRequest: allOf: - $ref: '#/components/schemas/ValidateStackSetArnRequest' - type: object additionalProperties: false required: - enableStackModify - awsOrganizationName properties: awsOrganizationName: type: string description: Not required. nullable: true enableStackModify: type: boolean description: Required. Default is false, it's for future use. ValidateStackSetArnRequest: allOf: - $ref: '#/components/schemas/OnboardingPermissionRequest' - type: object additionalProperties: false required: - stackSetArn properties: stackSetArn: type: string description: The created StackSet ARN. pattern: ^arn:(?(aws[\w\-]*)):(?[\w]*):(?[\w\d-]*):(?[\d]*):stackset\/(((?[\w+=,\.@\-_ ]+)[\/]?)+):(((?[\w+=,\.@\-_ ]+)[\/:]?)+)?$ OnboardingPermissionRequest: type: object additionalProperties: false required: - secret - workflowId - roleArn - apiKey properties: workflowId: type: string description: Not required format: guid default: 9dae2043-7b84-4afe-a3ff-e11ceebc22a2 roleArn: type: string description: 'CloudGuard role arn from AWS. AWS China accounts supported only in CloudGuard China DC.' pattern: ^arn:(aws|aws-cn):iam::\d{12}:role\/[A-Za-z0-9]+(?:-[A-Za-z0-9]+)+$ secret: type: string description: 'Also known as ExternalId from management-stack API. this value should be the one that returns from: management-stack API.' pattern: ^[\w+=,.@:\/-]{12,1224}$ apiKey: type: string description: 'Should be null. Needed only for ''UserBased'' Type.' nullable: true OnboardingUpdateRequest: type: object additionalProperties: false required: - awsOrganizationName - enableStackModify properties: awsOrganizationName: type: string description: AWS organization name. nullable: true enableStackModify: type: boolean description: Required. Default is false, it's for future use. UpdateStackSetArnRequest: type: object additionalProperties: false required: - stackSetArn properties: stackSetArn: type: string description: The created StackSet ARN. pattern: ^arn:(?(aws[\w\-]*)):(?[\w]*):(?[\w\d-]*):(?[\d]*):stackset\/(((?[\w+=,\.@\-_ ]+)[\/]?)+):(((?[\w+=,\.@\-_ ]+)[\/:]?)+)?$ UpdateConfigurationRequest: type: object additionalProperties: false required: - mappingStrategy - postureManagement - organizationRootOuId properties: organizationRootOuId: type: string format: guid nullable: true mappingStrategy: $ref: '#/components/schemas/MappingStrategyType' postureManagement: $ref: '#/components/schemas/PostureManagementConfiguration' ManagementCftConfiguration: allOf: - $ref: '#/components/schemas/OnboardingCftBase' - type: object additionalProperties: false required: - managementCftUrl - isManagementOnboarded properties: managementCftUrl: type: string description: Management Cft Url for s3. isManagementOnboarded: type: boolean description: Is management account already onboarded to CloudGuard. OnboardingCftBase: type: object additionalProperties: false required: - externalId - content properties: externalId: type: string description: Used in the CloudGuard role. content: type: string description: Content of the CFT. OnboardingMemberCft: allOf: - $ref: '#/components/schemas/OnboardingCftBase' - type: object additionalProperties: false required: - onboardingCftUrl properties: onboardingCftUrl: type: string OrganizationManagementViewModel2: type: object additionalProperties: false required: - id - accountId - userId - organizationName - tenantId - managementGroupId - appRegistrationName - onboardingConfiguration - managedSubscriptionsIds - updateTime - creationTime - isAutoOnboarding - onboardingVersions properties: id: type: string format: guid accountId: type: integer format: int64 userId: type: integer format: int32 organizationName: type: string tenantId: type: string managementGroupId: type: string appRegistrationName: type: string nullable: true onboardingConfiguration: $ref: '#/components/schemas/AzureOrganizationOnboardingConfiguration' managedSubscriptionsIds: type: array items: type: string updateTime: type: string format: date-time creationTime: type: string format: date-time isAutoOnboarding: type: boolean onboardingVersions: $ref: '#/components/schemas/OnboardingVersions' AzureOrganizationOnboardingConfiguration: allOf: - $ref: '#/components/schemas/OrganizationOnboardingConfigurationBase' - type: object additionalProperties: false required: - awpConfiguration - serverlessConfiguration - cdrConfiguration - isAutoOnboarding properties: awpConfiguration: description: AWP blade configuration nullable: true oneOf: - $ref: '#/components/schemas/AwpConfiguration' serverlessConfiguration: description: Serverless blade configuration nullable: true oneOf: - $ref: '#/components/schemas/ServerlessConfiguration' cdrConfiguration: description: CDR blade configuration nullable: true oneOf: - $ref: '#/components/schemas/CdrConfiguration' isAutoOnboarding: type: boolean AwpConfiguration: allOf: - $ref: '#/components/schemas/BladeConfiguration' - type: object additionalProperties: false required: - onboardingMode - centralizedSubscriptionId - withFunctionAppsScan - withSseCmkEncryptedDisksScan properties: onboardingMode: default: 1 $ref: '#/components/schemas/AwpOnboardingMode' centralizedSubscriptionId: type: string nullable: true withFunctionAppsScan: type: boolean withSseCmkEncryptedDisksScan: type: boolean AwpOnboardingMode: type: string description: '' x-enumNames: - saas - inAccount - inAccountHub enum: - saas - inAccount - inAccountHub BladeConfiguration: type: object additionalProperties: false required: - isEnabled properties: isEnabled: type: boolean ServerlessConfiguration: allOf: - $ref: '#/components/schemas/BladeConfiguration' - type: object additionalProperties: false CdrConfiguration: allOf: - $ref: '#/components/schemas/BladeConfiguration' - type: object additionalProperties: false required: - accounts properties: accounts: type: array nullable: true items: $ref: '#/components/schemas/StorageAccount' StorageAccount: type: object additionalProperties: false required: - storageId - logTypes properties: storageId: type: string nullable: true logTypes: type: array nullable: true items: type: string OnboardingVersions: type: object additionalProperties: false required: - currentVersion - latestVersion properties: currentVersion: type: string latestVersion: type: string nullable: true OnboardingRequest2: type: object additionalProperties: false required: - tenantId - workflowId - managementGroupId - organizationName - appRegistrationName - clientId - clientSecret - activeBlades - vendor - useCloudGuardManagedApp - isAutoOnboarding properties: workflowId: type: string description: Not required format: guid default: 780beebe-b33b-48bf-8bb4-1239da4b8e9c tenantId: type: string description: 'Required The Tenant ID to onboard' managementGroupId: type: string description: The Management Group ID to onboard nullable: true organizationName: type: string description: Not required. Default is 'AzureOrg' nullable: true appRegistrationName: type: string description: 'Required only if non UseCloudGuardManagedApp mode is used The name of the application created in the script' nullable: true clientId: type: string description: 'Application (client) ID Required only if non UseCloudGuardManagedApp mode is used The value of this field is printed at the end of the script' format: guid nullable: true clientSecret: type: string description: 'Required only if non UseCloudGuardManagedApp mode is used The value of this field is printed at the end of the script' nullable: true activeBlades: description: Required. Indicates which blades to Activate deprecated: true x-deprecatedMessage: Blades are created using the policy assignment metadata instead nullable: true oneOf: - $ref: '#/components/schemas/Blades' vendor: description: 'Required. Default is azure Allowed values: azure, azuregov, azurechina' default: 4 oneOf: - $ref: '#/components/schemas/CloudVendor' useCloudGuardManagedApp: type: boolean description: 'Specifies whether to use the Check Point application to connect the subscriptions to CloudGuard Required' isAutoOnboarding: type: boolean description: 'Optional. Default is true Declares if the onboarding pipeline automatically onboards newly discovered subscriptions after the initial onboarding. ' default: true Blades: type: object additionalProperties: false required: - awp - serverless - cdr - postureManagement properties: awp: $ref: '#/components/schemas/AwpConfiguration' serverless: $ref: '#/components/schemas/ServerlessConfiguration' cdr: $ref: '#/components/schemas/CdrConfiguration' postureManagement: $ref: '#/components/schemas/PostureManagement' PostureManagement: type: object additionalProperties: false required: - onboardingMode properties: onboardingMode: $ref: '#/components/schemas/OnboardingMode' OnboardingUpdateRequest2: type: object additionalProperties: false required: - organizationName properties: organizationName: type: string description: New Organization Name GcpOnboardingExecCmdResponse: type: object additionalProperties: false required: - executionCommand properties: executionCommand: type: string ScopeMode: type: string description: '' x-enumNames: - Project - Folder - Organization enum: - Project - Folder - Organization GetOnboardingScriptForPreviewResponse: type: object additionalProperties: false required: - script properties: script: type: string requestBodies: Dome9.BL.Std.Services.OrganizationalUnit.MoveOrganizationalUnitViewModel: content: application/json: schema: $ref: '#/components/schemas/Dome9.BL.Std.Services.OrganizationalUnit.MoveOrganizationalUnitViewModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.BL.Std.Services.OrganizationalUnit.MoveOrganizationalUnitViewModel' description: The guids of the source organizational unit to detach from and the target organizational unit to attach to. Use null for root organizational unit. required: true Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel2: content: application/json: schema: $ref: '#/components/schemas/Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel' required: true Dome9.BL.Std.Services.OrganizationalUnit.AttachCloudAccountsViewModel: content: application/json: schema: $ref: '#/components/schemas/Dome9.BL.Std.Services.OrganizationalUnit.AttachCloudAccountsViewModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.BL.Std.Services.OrganizationalUnit.AttachCloudAccountsViewModel' required: true Dome9.BL.Std.Services.OrganizationalUnit.MoveOrganizationalUnitViewModel2: content: application/json: schema: $ref: '#/components/schemas/Dome9.BL.Std.Services.OrganizationalUnit.MoveOrganizationalUnitViewModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Dome9.BL.Std.Services.OrganizationalUnit.MoveOrganizationalUnitViewModel' required: true securitySchemes: basic: type: http scheme: basic security: - basic: [] x-readme: explorer-enabled: true proxy-enabled: true