Sign in
Shared Tokens (cdx/v1)

Redeem token

General Availability

Redeem the shared token for shared topic and cluster access information

post/cdx/v1/shared-tokens:redeem

Request body

api_version'cdx/v1'

APIVersion defines the schema version of this representation of a resource.

kind'RedeemTokenRequest'

Kind defines the object this REST resource represents.

idstring

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

tokenstring required

The encrypted token

aws_accountstring

Consumer's AWS account ID for PrivateLink access.

azure_subscriptionstring

Consumer's Azure subscription ID for PrivateLink access.

gcp_projectstring

Consumer's GCP project ID for Private Service Connect access.

Example request

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/cdx/v1/redeem-token-requests/rtr-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/redeem-token-request=rtr-12345",
    "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"
  },
  "aws_account": "000000000000",
  "azure_subscription": "00000000-0000-0000-0000-000000000000"
}

Response

Consumer redeems shared token

api_version'cdx/v1'

APIVersion defines the schema version of this representation of a resource.

kind'RedeemTokenResponse'

Kind defines the object this REST resource represents.

idstring

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

api_keystring

The api key

secretstring

The api key secret

kafka_bootstrap_urlstring uri

The kafka cluster bootstrap url

schema_registry_api_keystring

The api key for schema registry

schema_registry_secretstring

The api key secret for schema registry

schema_registry_urlstring uri

The schema registry endpoint url

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/cdx/v1/redeem-token-responses/rtr-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/redeem-token-response=rtr-12345",
    "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"
  },
  "kafka_bootstrap_url": "SASL://pkc-xxxxx.us-west-2.aws.confluent.cloud:9092",
  "schema_registry_url": "https://psrc-xxxxx.us-west-2.aws.confluent.cloud"
}

Changes

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