1. Organizations
CG Scanning API V2
5.5.x
  • latest
  • 5.4.2
  • 5.5.x
  • Scanning API
    • Getting Started
    • Authentication
    • Common Error Responses
    • Filtering Data
    • Core Workflows
    • Authentication
      • User Confirmation
        • Confirm a User
        • Show confirmation form
      • User Invitation
        • Accept an invitation
        • Pre-Accept invitation check
      • Password Reset
        • Forgot Password
        • Reset Password
      • Impersonation
        • Impersonate user
        • Impersonate user
      • MFA
        • Check 2fa
        • Send SMS OTP
      • Sign in authentication
      • Sign in with recovery code
      • Sign out authentication
      • SSO Link login
    • Targets
      • List targets
      • Create Target
      • Show a target
      • Updates a target
      • Delete a target
      • Delete targets
      • Calculate Hosts
    • Scans
      • Scan Histories
        • List of history for a scan
        • History details for a scan
      • Scan Hosts
        • List of hosts for a scan
        • Host details for a scan
      • Scan Vulnerabilities
        • List of vulnerabilities for a scan
        • Show vulnerability details
        • Statistics for a scan
      • Scan Profiles (Configs)
        • List Activated Scan Profiles
      • List scans
      • Create Scan
      • Show a scan
      • Updates a scan
      • Delete a scan
      • Delete scans
      • Start a scan
      • Stop a scan
      • List upcoming scans
      • List recent scans that have been completed
      • List of the running scans
      • Create Scan from Wizard
    • Reports
      • List Reports
      • Show a report
      • Delete a report
      • Delete reports
      • Generates a report file
      • Downloads a report file
      • Check if a report file exists
      • Verifies file integrity by comparing hashes
    • Vulnerabilities
      • List of vulnerabilities
      • Vulnerability details
      • Total Vulnerabilities (widget)
      • Top Vulnerabilities (widget)
      • PCI Compliant (widget)
    • Exceptions
      • List Exceptions
      • Create Exception
      • Update Exception
      • Show an exception
      • Delete an exception
      • Show exception details
      • Delete exceptions
      • Activate exceptions
      • Reset exceptions
      • Show the exceptions statistics
    • Advanced Reports
      • List Advanced Reports
      • Create an advanced report
      • Show an advanced report
      • Update an advanced report
      • Delete an advanced report
      • Delete advanced reports
      • Generates an advanced report file
      • Downloads an advanced report file
    • Credentials
      • List Credentials
      • Show Credential
      • Delete Credential
      • Create Credential
      • Update Credential
    • Audit
      • Get all events
      • Get event by id
    • Notifications
      • List Notifications
      • Show a notification
      • Delete a notification
      • Mark as read a notification
      • Mark as seen a notification
      • Mark as read all notifications
      • Mark as seen all notifications
    • Hosts
      • List of hosts
      • Host details
      • List of most vulnerable hosts
    • Organizations
      • Organization Subscriptions
        • Retrieves all subscriptions of organization
        • Retrieves all active subscriptions of organization
        • Show a subscription of organization
        • Update organization's subscription
        • Assign features to a subscription
        • Revoke features from a subscription
      • Subscribe to a plan
        POST
      • List organizations
        GET
      • Create Organization
        POST
      • List dependent subscriptions
        GET
      • Retrieve an organization
        GET
      • Update an organization
        PUT
      • Delete an organization
        DELETE
      • Subscribe an organization to a plan
        POST
      • Unsubscribe an organization from a plan
        POST
      • Change users Organization
        PUT
      • Export organizations
        GET
    • Whitelabel Settings
      • Show the white label settings
      • Show the white label settings
      • Update white label settings
    • Scanners
      • List scanners
      • Create scanner
      • Show scanner
      • Update scanner
      • Delete scanner
      • List activated scanners
      • Activate scanner
      • Deactivate scanner
      • Update scanner app type
      • Assign a scanner to an organization
      • Verify a scanner
    • Schedules
      • List Schedules
      • Create Schedule
      • Updates a schedule
      • Show a schedule
      • Delete a schedule
      • Delete schedules
      • Calculate First Time Schedule Date
      • Calculate Next Schedule Dates
    • Port Lists
      • List port lists
      • Create a port list
      • Show a port list
      • Update a port list
      • Delete a port list
      • List activated port lists
      • Add a port range to a port list
      • Delete a port range to a port list
      • Activate a port list
      • Deactivate a port list
      • Updates the app_type of a port list
      • Sync the a port lists
    • User
      • User 2FA
        • Enable 2FA
        • Verify 2FA installation
        • Disable 2FA
        • Lookup phone number
        • Default 2FA method
        • Generate Recovery Codes
        • Get Recovery Codes
      • User Preferences
        • Get users notification preferences
        • Change users product
        • Enable user's event notification preference
        • Disable user's event notification preference
      • Get current user
      • Update current user
      • Change current user password
      • Get current user active plans (Not implemented yet)
      • Get organization members
      • Get current user products
      • Get current organization
      • Update current organization
      • Get subscriptions history
      • Change users product
      • Checks if authorization token is valid
      • Get current user permissions
      • Check if the user can be deleted
      • Delete my account
      • Generates a new access token
      • Revokes the current access token
      • Transfers all the resources from the user to another user
    • Users
      • List Users
      • Create User
      • Show User
      • Update User
      • Delete a User
      • Create Customer
      • Invite User
      • Resend Confirmation Instructions
      • Import Users
      • Check if a user can be deleted
      • Inherit all the resources from a user
      • Export all users to a CSV file
      • Set partner
      • Unset partner
    • Webhooks
      • Deliveries
        • List all deliveries for a webhook
        • Get a delivery for a webhook
      • List all webhooks
      • Create a webhook
      • Show a webhook
      • Update a webhook
      • Delete a webhook
      • Activate a webhook
      • Deactivate a webhook
    • Schemas
      • Schemas
        • vulnerabilityData
        • SingleResponseBase
        • CollectionResponseBase
        • TargetResource
        • TargetResponse
        • TargetAttributes
        • TargetsListResponse
        • errors_map
        • OwnerAttributes
        • FeaturesBodyRequest
        • errorObject
        • ErrorResponse
        • not_found
        • forbidden
        • unauthorized
        • unprocessable_entity
        • pagination
        • meta
        • target
        • scan
        • product
        • productsResponse
  • SAQ API
    • List all SAQs
    • List Available SAQ Types
    • Get SAQ Type Template
    • Get SAQ (JSON) or Download SAQ (PDF)
    • Create a New SAQ
    • Delete an SAQ
    • Clone an SAQ
    • Approve an SAQ
    • Set SAQ as a template
Home
DocsPurchase PCI ASV Certified Scan
Home
DocsPurchase PCI ASV Certified Scan
5.5.x
  • latest
  • 5.4.2
  • 5.5.x
  1. Organizations

Create Organization

POST
/v2/organizations
Last modified:2026-03-26 17:17:13
Create a new organization in your Clone Guard® Security Scanning portal and optionally subscribe it to one or more product plans.
By default, when an organization is created, the system will attempt to subscribe it to the configured default plan (if one exists).
If no default plan is configured, the organization will be created without any active subscriptions.
You can override this behavior by setting
skip_default_subscription to true,
in which case you must explicitly provide the plans parameter to define one or more subscriptions during creation.
Product and Plans
Organizations require an active subscription to a product plan in order to be fully functional and able to use the platform’s features.
Currently, plans must be created and managed through the Scanning Solution Portal (Admin Dashboard).
API support for plan management will be available in a future release.

Subscription Behavior#

Default behavior:
If a default plan exists → the organization is automatically subscribed to it
If no default plan exists → the organization is created without subscriptions
Custom behavior (skip_default_subscription = true):
The plans parameter becomes required
The organization will be subscribed only to the plans provided in the request

plans#

An array of subscription objects used to assign one or more product plans to the organization during creation.
Each item has the following structure:
plan (string): The plan code
interval (string): none, monthly, or yearly
start_date (datetime, optional)
end_date (datetime, optional)
You can include multiple plans in the array to subscribe the organization to different products.
Important Notes
An organization can have only one active subscription per product.
If multiple plans from the same product (e.g. PCI) are provided, only the first one will be applied.
Additional plans for the same product will be ignored.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
or
Body Params application/json

Example
{
    "organization": {
        "name": "string",
        "description": "string",
        "parent_organization": "5d702bf8-e908-41df-92de-feea0acf2f4e",
        "skip_default_subscription": true,
        "plans": [
            {
                "plan": "pci-basic",
                "partner": true,
                "interval": "none",
                "start_date": "string",
                "end_date": "string"
            }
        ]
    }
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/organizations' \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "organization": {
        "name": "string",
        "description": "string",
        "parent_organization": "5d702bf8-e908-41df-92de-feea0acf2f4e",
        "skip_default_subscription": true,
        "plans": [
            {
                "plan": "pci-basic",
                "partner": true,
                "interval": "none",
                "start_date": "string",
                "end_date": "string"
            }
        ]
    }
}'

Responses

🟢201Created
Organization Created
This response does not have a body.
Examples
{
    "errors": [
        {
            "message": "Plan not found",
            "type": "exception",
            "timestamp": "2021-09-29T14:00:00.000Z"
        }
    ]
}
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🟠422Parameter Error
Modified at 2026-03-26 17:17:13
Previous
List organizations
Next
List dependent subscriptions
Built with