Create Organization

POST

/v2/organizations

Last modified:2025-09-01 18:52:30

Create a new organization in your Clone Guard® Security Scanning portal and associate users with this customer.

This endpoint allows you to create a new organization with optional subscriptions to specific plans.
The plans field is required in the following cases:

If skip_default_subscription is set to true.

If no default plans are configured in the system.

You can pass multiple plans at once, one for each available product,
to subscribe the organization to different products during creation.

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: ********************

Body Params application/json

Examples

Responses

🟢201Created

Organization Created

This response does not have a body.

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error

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"
            }
        ]
    }
}'

Response Example

401 - Example 1

{
    "errors": [
        {
            "message": "string",
            "type": "string",
            "timestamp": "string"
        }
    ]
}

Modified at 2025-09-01 18:52:30

List organizations

List dependent subscriptions