Sign in
Provider Shares (cdx/v1)

List of Provider Shares

General Availability

Retrieve a sorted, filtered, paginated list of all provider shares.

get/cdx/v1/provider-shares

Query parameters

shared_resourcestring

Filter a collection by a string search

Filter the results by exact match for shared_resource.

crnstring

Filter a collection by a string search

Filter the results by exact match for crn.

include_deletedboolean

Filter for whether this value is true or false.

Include deactivated shares

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

Provider Share.

api_version'cdx/v1' required

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

kind'ProviderShareList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/cdx/v1/provider-shares",
    "last": "https://api.confluent.cloud/cdx/v1/provider-shares?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/cdx/v1/provider-shares?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/cdx/v1/provider-shares?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "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",
      "service_account": {
        "id": "sa-4voj5e",
        "related": "https://api.confluent.cloud/iam/v2/service-accounts/sa-4voj5e",
        "resource_name": "https://api.confluent.cloud/service-account=sa-4voj5e"
      },
      "cloud_cluster": {
        "id": "lkc-00000",
        "related": "https://api.confluent.cloud/cmk/v2/clusters/lkc-00000",
        "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000"
      },
      "status": {
        "phase": "ACTIVE"
      }
    }
  ]
}

Changes

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