Recipients
List share recipients by share ID
Get share recipient by ID
Create a new share recipient
Delete a share recipient
ModelsExpand Collapse
RecipientListResponse object { id, account_id, association_status, 3 more } 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.
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.
association_status: "associating" or "associated" or "disassociating" or "disassociated"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.
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.
RecipientGetResponse object { id, account_id, association_status, 3 more } 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.
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.
association_status: "associating" or "associated" or "disassociating" or "disassociated"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.
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.
RecipientCreateResponse object { id, account_id, association_status, 3 more } 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.
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.
association_status: "associating" or "associated" or "disassociating" or "disassociated"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.
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.
RecipientDeleteResponse object { id, account_id, association_status, 3 more } 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.
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.
association_status: "associating" or "associated" or "disassociating" or "disassociated"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.
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.