Sign in
Shared Tokens (cdx/v1)

Validate token to view shared resources

General Availability

Validate and decrypt the shared token and view token's shared resources

post/cdx/v1/shared-tokens:resources

Request body

api_version'cdx/v1'

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

kind'SharedToken'

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

Example request

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/cdx/v1/shared-tokens/st-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/shared-token=st-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"
  }
}

Response

Consumer validates share token and view consumer resources before redeeming in the workflow

Example response

{
  "consumer_shared_resources": [
    {
      "id": "dlz-f3a90de",
      "metadata": {
        "self": "https://api.confluent.cloud/cdx/v1/consumer-shared-resources/csr-12345",
        "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/consumer-shared-resource=csr-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"
      },
      "cloud": "AWS",
      "network_connection_types": [
        "PRIVATELINK"
      ],
      "display_name": "Stock Trades",
      "description": "This topic provides realtime data for the orders placed through the website",
      "tags": [
        "recent",
        "pending"
      ],
      "schemas": [
        {
          "subject": "User",
          "version": 1,
          "id": 100001,
          "schema_type": "AVRO",
          "schema": "{\"schema\": \"{\"type\": \"string\"}\"}"
        }
      ],
      "organization_name": "ABC Corp",
      "organization_description": "ABC Corp is the biggest online retailer",
      "organization_contact": "jane.doe@example.com",
      "logo_url": "https://confluent.cloud/api/cdx/v1/consumer-shared-resources/sr-123/images/logo"
    }
  ]
}

Changes

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