signups

Creates, updates, deletes, gets or lists a signups resource.

Overview

Name	signups
Type	Resource
Id	confluent.partner.signups

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
signup	exec	organization, entitlement	dry_run	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.
activate_signup	exec	user, organization_id		Creates a user in the organization previously created in /partner/v2/signup. This completes the signup process if you did not pass in user details to /partner/v2/signup. Calling this endpoint if the signup process has been completed will result in a 409 Conflict error.
signup_partner_v2_link	exec	token, organization, entitlement	dry_run	Signup a customer by linking a new entitlement to an existing Confluent Cloud organization.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dry_run	boolean	If true, only perform validation of signup

Lifecycle Methods

signup

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.

EXEC confluent.partner.signups.signup 
@dry_run={{ dry_run }} 
@@json=
'{
"organization": "{{ organization }}", 
"user": "{{ user }}", 
"entitlement": "{{ entitlement }}"
}'
;

activate_signup

Creates a user in the organization previously created in /partner/v2/signup. This completes the signup
process if you did not pass in user details to /partner/v2/signup. Calling this endpoint if the signup
process has been completed will result in a 409 Conflict error.

EXEC confluent.partner.signups.activate_signup 
@@json=
'{
"user": "{{ user }}", 
"organization_id": "{{ organization_id }}"
}'
;

signup_partner_v2_link

Signup a customer by linking a new entitlement to an existing Confluent Cloud organization.

EXEC confluent.partner.signups.signup_partner_v2_link 
@dry_run={{ dry_run }} 
@@json=
'{
"token": "{{ token }}", 
"organization": "{{ organization }}", 
"entitlement": "{{ entitlement }}"
}'
;