List share recipients by share ID

client.ResourceSharing.Recipients.List(ctx, shareID, params) (*V4PagePaginationArray[RecipientListResponse], error)

GET/accounts/{account_id}/shares/{share_id}/recipients

List share recipients by share ID. Returns all recipients regardless of their association_status (associating, associated, disassociating, disassociated). Callers that want only “active” recipients must filter client-side on the association_status field.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

shareID string

Share identifier tag.

maxLength32

minLength32

params RecipientListParams

AccountID param.Field[string]

Path param: Account identifier.

maxLength32

minLength32

IncludeResources param.Field[bool]Optional

Query param: Include resources in the response.

Page param.Field[int64]Optional

Query param: Page number. Defaults to 1 when omitted.

minimum1

multipleOf1

PerPage param.Field[int64]Optional

Query param: Number of objects to return per page. Defaults to 20 when omitted.

maximum100

minimum1

multipleOf1

ReturnsExpand Collapse

type RecipientListResponse struct{…}

A recipient of a share. The association_status field tracks the lifecycle of the shared resources in the recipient account. All recipients are returned by the list endpoint regardless of status; filter client-side if only active recipients are needed.

ID string

Share Recipient identifier tag.

maxLength32

minLength32

AccountID string

Account identifier.

maxLength32

minLength32

AssociationStatus RecipientListResponseAssociationStatus

The current state of the recipient relative to the share. The desired_association_status (not exposed in the response) tracks the target state set by the API; the background reconciliation workflow drives current_association_status toward it.

associating — The recipient was recently added; the workflow is pushing shared resources into the recipient account.
associated — Shared resources have been successfully applied to the recipient account.
disassociating — The recipient was removed (via DELETE or PUT replacement); the workflow is removing shared resources from the recipient account.
disassociated — Shared resources have been removed from the recipient account. The recipient record remains in the database.

One of the following:

const RecipientListResponseAssociationStatusAssociating RecipientListResponseAssociationStatus = "associating"

const RecipientListResponseAssociationStatusAssociated RecipientListResponseAssociationStatus = "associated"

const RecipientListResponseAssociationStatusDisassociating RecipientListResponseAssociationStatus = "disassociating"

const RecipientListResponseAssociationStatusDisassociated RecipientListResponseAssociationStatus = "disassociated"

Created Time

When the object was created.

formatdate-time

Modified Time

When the object was last modified.

formatdate-time

Resources []RecipientListResponseResourceOptional

Error string

Error from the most recent attempt to apply the resource to the recipient. Empty string when no error has been recorded.

ResourceID string

Identifier assigned by the service that owns the shared resource.

ResourceVersion int64

Resource version applied to the recipient, if reconciliation has occurred.

Terminal bool

Whether the error is terminal or will be continually retried.

List share recipients by share ID

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/resource_sharing"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  page, err := client.ResourceSharing.Recipients.List(
    context.TODO(),
    "3fd85f74b32742f1bff64a85009dda07",
    resource_sharing.RecipientListParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "3fd85f74b32742f1bff64a85009dda07",
      "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
      "association_status": "associating",
      "created": "2023-09-21T18:56:32.624632Z",
      "modified": "2023-09-21T18:56:32.624632Z",
      "resources": [
        {
          "error": "Recipient is missing necessary entitlement",
          "resource_id": "0a679032-bbb2-4b7e-9acc-dd5c5cb27a17",
          "resource_version": 0,
          "terminal": true
        }
      ]
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 50
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "3fd85f74b32742f1bff64a85009dda07",
      "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
      "association_status": "associating",
      "created": "2023-09-21T18:56:32.624632Z",
      "modified": "2023-09-21T18:56:32.624632Z",
      "resources": [
        {
          "error": "Recipient is missing necessary entitlement",
          "resource_id": "0a679032-bbb2-4b7e-9acc-dd5c5cb27a17",
          "resource_version": 0,
          "terminal": true
        }
      ]
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 50
  }
}