Sign in
Provider Shares (cdx/v1)

Create a provider share

General Availability

Creates a share based on delivery method.

post/cdx/v1/provider-shares

Request body

api_version'cdx/v1'

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

kind'CreateProviderShareRequest'

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

delivery_methodstring required

Method by which the invite will be delivered

resourcesstring[] required

List of resource crns to be shared

Example request

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/cdx/v1/create-provider-share-requests/cpsr-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/create-provider-share-request=cpsr-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"
  },
  "delivery_method": "EMAIL",
  "resources": [
    "crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic"
  ]
}

Response

Response is the provider share

api_version'cdx/v1'

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

kind'ProviderShare'

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

consumer_user_namestring

Name of the consumer

consumer_organization_namestring

Consumer organization name

provider_user_namestring

Name or email of the provider user. Deprecated

delivery_methodstring

Method by which the invite will be delivered

invited_atstring date-time

The date and time at which consumer was invited

invite_expires_atstring date-time

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

redeemed_atstring date-time

The date and time at which the invite was redeemed

Example response

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

Changes

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