Signup (partner/v2)

Signup an Organization on behalf of a Customer

Early Access Request Access To Partner v2

Create an organization for a customer. You must pass in either an entitlement object reference (a url to a previously created entitlement) or entitlement details. If you pass in an entitlement object reference, we will link with the created entitlement. If you pass in the entitlement details, we will create the entitlement with the organization in a single transaction. If you pass in user details (email, given name, and family name), we will create a user as well. If you do not pass in user details, you MUST call /partner/v2/signup/activate with user details to complete signup.

post/partner/v2/signup

Query parameters

dry_runboolean

If true, only perform validation of signup

Request body

userobject

Example request

{
  "organization": {
    "id": "dlz-f3a90de",
    "metadata": {
      "self": "https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de",
      "resource_name": "crn://confluent.cloud/kafka=lkc-f3a90de",
      "created_at": "2006-01-02T15:04:05-07:00",
      "updated_at": "2006-01-02T15:04:05-07:00",
      "deleted_at": "2006-01-02T15:04:05-07:00"
    },
    "name": "Acme Organization",
    "sso_url": "https://confluent.cloud/login/sso/AzureAD-OIDC-Conn",
    "sso_config": {
      "kind": "AzureSSOConfig",
      "tenant_id": "b3a17773-05cc-4431-9560-433fb4613da8"
    }
  },
  "entitlement": {
    "id": "dlz-f3a90de",
    "metadata": {
      "self": "https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de",
      "resource_name": "crn://confluent.cloud/kafka=lkc-f3a90de",
      "created_at": "2006-01-02T15:04:05-07:00",
      "updated_at": "2006-01-02T15:04:05-07:00",
      "deleted_at": "2006-01-02T15:04:05-07:00"
    },
    "external_id": "1111-2222-3333-4444",
    "name": "Acme Prod Entitlement",
    "plan_id": "confluent-cloud-payg-prod",
    "product_id": "confluent-cloud-kafka-service-azure",
    "usage_reporting_id": "1111-2222-3333-4444",
    "resource_id": "1111-2222-3333-4444"
  }
}

Response

Successful signup.

organization_idstring required

The ID of the organization

sso_urlstring uri required

The login URL for the customer to access Confluent Cloud

display_messagestring

The display message contains useful information which is shown on the Marketplace UI to the customers.

Example response

{
  "organization_id": "b3a17773-05cc-4431-9560-433fb4613da8",
  "sso_url": "https://confluent.cloud/login/sso/AzureAD-OIDC-Conn",
  "display_message": "Your support plan will remain the same, to change the plan, follow this [link](https://docs.confluent.io/cloud/current/faq.html#how-do-i-change-support-plans)."
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.