Sign in
Consumer Shares (cdx/v1)

Read a Consumer Share

General Availability

Make a request to read a consumer share.

get/cdx/v1/consumer-shares/{id}

Path parameters

idstring required

The unique identifier for the consumer share.

Response

Consumer Share.

api_version'cdx/v1' required

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

kind'ConsumerShare' required

Kind defines the object this REST resource represents.

idstring required

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").

provider_organization_namestring required

Provider organization name

provider_user_namestring required

Name or email of the provider user

invite_expires_atstring date-time

The date and time at which the invitation will expire. Only for invited shares

consumer_organization_namestring

Consumer organization name. Deprecated

consumer_user_namestring

Name of the consumer. Deprecated

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/cdx/v1/consumer-shares/cs-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/consumer-share=cs-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"
  },
  "provider_organization_name": "Nasdaq",
  "provider_user_name": "Jane Doe",
  "invite_expires_at": "2006-01-02T15:04:05-07:00",
  "consumer_organization_name": "Nasdaq",
  "consumer_user_name": "John Doe",
  "status": {
    "phase": "ACTIVE"
  }
}

Changes

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