API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Resource Sharing

List account shares

resource_sharing.list(ResourceSharingListParams**kwargs) -> SyncV4PagePaginationArray[ResourceSharingListResponse]

GET/accounts/{account_id}/shares

Get account share by ID

resource_sharing.get(strshare_id, ResourceSharingGetParams**kwargs) -> ResourceSharingGetResponse

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

Create a new share

resource_sharing.create(ResourceSharingCreateParams**kwargs) -> ResourceSharingCreateResponse

POST/accounts/{account_id}/shares

Update a share

resource_sharing.update(strshare_id, ResourceSharingUpdateParams**kwargs) -> ResourceSharingUpdateResponse

PUT/accounts/{account_id}/shares/{share_id}

Delete a share

resource_sharing.delete(strshare_id, ResourceSharingDeleteParams**kwargs) -> ResourceSharingDeleteResponse

DELETE/accounts/{account_id}/shares/{share_id}

ModelsExpand Collapse

class ResourceSharingListResponse: …

id: str

Share identifier tag.

maxLength32

account_id: str

Account identifier.

maxLength32

account_name: str

The display name of an account.

created: datetime

When the share was created.

formatdate-time

modified: datetime

When the share was modified.

formatdate-time

name: str

The name of the share.

organization_id: str

Organization identifier.

maxLength32

status: Literal["active", "deleting", "deleted"]

One of the following:

"active"

"deleting"

"deleted"

target_type: Literal["account", "organization"]

One of the following:

"account"

"organization"

associated_recipient_count: Optional[int]

The number of recipients in the 'associated' state. This field is only included when requested via the 'include_recipient_counts' parameter.

associating_recipient_count: Optional[int]

The number of recipients in the 'associating' state. This field is only included when requested via the 'include_recipient_counts' parameter.

disassociated_recipient_count: Optional[int]

The number of recipients in the 'disassociated' state. This field is only included when requested via the 'include_recipient_counts' parameter.

disassociating_recipient_count: Optional[int]

The number of recipients in the 'disassociating' state. This field is only included when requested via the 'include_recipient_counts' parameter.

kind: Optional[Literal["sent", "received"]]

One of the following:

"sent"

"received"

resources: Optional[List[Resource]]

A list of resources that are part of the share. This field is only included when requested via the 'include_resources' parameter.

id: str

Share Resource identifier.

maxLength32

created: datetime

When the share was created.

formatdate-time

meta: object

Resource Metadata.

modified: datetime

When the share was modified.

formatdate-time

resource_account_id: str

Account identifier.

maxLength32

resource_id: str

Share Resource identifier.

maxLength32

resource_type: Literal["custom-ruleset", "gateway-policy", "gateway-destination-ip", 2 more]

Resource Type.

One of the following:

"custom-ruleset"

"gateway-policy"

"gateway-destination-ip"

"gateway-block-page-settings"

"gateway-extended-email-matching"

resource_version: int

Resource Version.

status: Literal["active", "deleting", "deleted"]

Resource Status.

One of the following:

"active"

"deleting"

"deleted"

class ResourceSharingGetResponse: …

id: str

Share identifier tag.

maxLength32

account_id: str

Account identifier.

maxLength32

account_name: str

The display name of an account.

created: datetime

When the share was created.

formatdate-time

modified: datetime

When the share was modified.

formatdate-time

name: str

The name of the share.

organization_id: str

Organization identifier.

maxLength32

status: Literal["active", "deleting", "deleted"]

One of the following:

"active"

"deleting"

"deleted"

target_type: Literal["account", "organization"]

One of the following:

"account"

"organization"

associated_recipient_count: Optional[int]

The number of recipients in the 'associated' state. This field is only included when requested via the 'include_recipient_counts' parameter.

associating_recipient_count: Optional[int]

The number of recipients in the 'associating' state. This field is only included when requested via the 'include_recipient_counts' parameter.

disassociated_recipient_count: Optional[int]

The number of recipients in the 'disassociated' state. This field is only included when requested via the 'include_recipient_counts' parameter.

disassociating_recipient_count: Optional[int]

The number of recipients in the 'disassociating' state. This field is only included when requested via the 'include_recipient_counts' parameter.

kind: Optional[Literal["sent", "received"]]

One of the following:

"sent"

"received"

resources: Optional[List[Resource]]

A list of resources that are part of the share. This field is only included when requested via the 'include_resources' parameter.

id: str

Share Resource identifier.

maxLength32

created: datetime

When the share was created.

formatdate-time

meta: object

Resource Metadata.

modified: datetime

When the share was modified.

formatdate-time

resource_account_id: str

Account identifier.

maxLength32

resource_id: str

Share Resource identifier.

maxLength32

resource_type: Literal["custom-ruleset", "gateway-policy", "gateway-destination-ip", 2 more]

Resource Type.

One of the following:

"custom-ruleset"

"gateway-policy"

"gateway-destination-ip"

"gateway-block-page-settings"

"gateway-extended-email-matching"

resource_version: int

Resource Version.

status: Literal["active", "deleting", "deleted"]

Resource Status.

One of the following:

"active"

"deleting"

"deleted"

class ResourceSharingCreateResponse: …

id: str

Share identifier tag.

maxLength32

account_id: str

Account identifier.

maxLength32

account_name: str

The display name of an account.

created: datetime

When the share was created.

formatdate-time

modified: datetime

When the share was modified.

formatdate-time

name: str

The name of the share.

organization_id: str

Organization identifier.

maxLength32

status: Literal["active", "deleting", "deleted"]

One of the following:

"active"

"deleting"

"deleted"

target_type: Literal["account", "organization"]

One of the following:

"account"

"organization"

associated_recipient_count: Optional[int]

The number of recipients in the 'associated' state. This field is only included when requested via the 'include_recipient_counts' parameter.

associating_recipient_count: Optional[int]

The number of recipients in the 'associating' state. This field is only included when requested via the 'include_recipient_counts' parameter.

disassociated_recipient_count: Optional[int]

The number of recipients in the 'disassociated' state. This field is only included when requested via the 'include_recipient_counts' parameter.

disassociating_recipient_count: Optional[int]

The number of recipients in the 'disassociating' state. This field is only included when requested via the 'include_recipient_counts' parameter.

kind: Optional[Literal["sent", "received"]]

One of the following:

"sent"

"received"

resources: Optional[List[Resource]]

A list of resources that are part of the share. This field is only included when requested via the 'include_resources' parameter.

id: str

Share Resource identifier.

maxLength32

created: datetime

When the share was created.

formatdate-time

meta: object

Resource Metadata.

modified: datetime

When the share was modified.

formatdate-time

resource_account_id: str

Account identifier.

maxLength32

resource_id: str

Share Resource identifier.

maxLength32

resource_type: Literal["custom-ruleset", "gateway-policy", "gateway-destination-ip", 2 more]

Resource Type.

One of the following:

"custom-ruleset"

"gateway-policy"

"gateway-destination-ip"

"gateway-block-page-settings"

"gateway-extended-email-matching"

resource_version: int

Resource Version.

status: Literal["active", "deleting", "deleted"]

Resource Status.

One of the following:

"active"

"deleting"

"deleted"

class ResourceSharingUpdateResponse: …

id: str

Share identifier tag.

maxLength32

account_id: str

Account identifier.

maxLength32

account_name: str

The display name of an account.

created: datetime

When the share was created.

formatdate-time

modified: datetime

When the share was modified.

formatdate-time

name: str

The name of the share.

organization_id: str

Organization identifier.

maxLength32

status: Literal["active", "deleting", "deleted"]

One of the following:

"active"

"deleting"

"deleted"

target_type: Literal["account", "organization"]

One of the following:

"account"

"organization"

associated_recipient_count: Optional[int]

The number of recipients in the 'associated' state. This field is only included when requested via the 'include_recipient_counts' parameter.

associating_recipient_count: Optional[int]

The number of recipients in the 'associating' state. This field is only included when requested via the 'include_recipient_counts' parameter.

disassociated_recipient_count: Optional[int]

The number of recipients in the 'disassociated' state. This field is only included when requested via the 'include_recipient_counts' parameter.

disassociating_recipient_count: Optional[int]

The number of recipients in the 'disassociating' state. This field is only included when requested via the 'include_recipient_counts' parameter.

kind: Optional[Literal["sent", "received"]]

One of the following:

"sent"

"received"

resources: Optional[List[Resource]]

A list of resources that are part of the share. This field is only included when requested via the 'include_resources' parameter.

id: str

Share Resource identifier.

maxLength32

created: datetime

When the share was created.

formatdate-time

meta: object

Resource Metadata.

modified: datetime

When the share was modified.

formatdate-time

resource_account_id: str

Account identifier.

maxLength32

resource_id: str

Share Resource identifier.

maxLength32

resource_type: Literal["custom-ruleset", "gateway-policy", "gateway-destination-ip", 2 more]

Resource Type.

One of the following:

"custom-ruleset"

"gateway-policy"

"gateway-destination-ip"

"gateway-block-page-settings"

"gateway-extended-email-matching"

resource_version: int

Resource Version.

status: Literal["active", "deleting", "deleted"]

Resource Status.

One of the following:

"active"

"deleting"

"deleted"

class ResourceSharingDeleteResponse: …

id: str

Share identifier tag.

maxLength32

account_id: str

Account identifier.

maxLength32

account_name: str

The display name of an account.

created: datetime

When the share was created.

formatdate-time

modified: datetime

When the share was modified.

formatdate-time

name: str

The name of the share.

organization_id: str

Organization identifier.

maxLength32

status: Literal["active", "deleting", "deleted"]

One of the following:

"active"

"deleting"

"deleted"

target_type: Literal["account", "organization"]

One of the following:

"account"

"organization"

associated_recipient_count: Optional[int]

The number of recipients in the 'associated' state. This field is only included when requested via the 'include_recipient_counts' parameter.

associating_recipient_count: Optional[int]

The number of recipients in the 'associating' state. This field is only included when requested via the 'include_recipient_counts' parameter.

disassociated_recipient_count: Optional[int]

The number of recipients in the 'disassociated' state. This field is only included when requested via the 'include_recipient_counts' parameter.

disassociating_recipient_count: Optional[int]

The number of recipients in the 'disassociating' state. This field is only included when requested via the 'include_recipient_counts' parameter.

kind: Optional[Literal["sent", "received"]]

One of the following:

"sent"

"received"

resources: Optional[List[Resource]]

A list of resources that are part of the share. This field is only included when requested via the 'include_resources' parameter.

id: str

Share Resource identifier.

maxLength32

created: datetime

When the share was created.

formatdate-time

meta: object

Resource Metadata.

modified: datetime

When the share was modified.

formatdate-time

resource_account_id: str

Account identifier.

maxLength32

resource_id: str

Share Resource identifier.

maxLength32

resource_type: Literal["custom-ruleset", "gateway-policy", "gateway-destination-ip", 2 more]

Resource Type.

One of the following:

"custom-ruleset"

"gateway-policy"

"gateway-destination-ip"

"gateway-block-page-settings"

"gateway-extended-email-matching"

resource_version: int

Resource Version.

status: Literal["active", "deleting", "deleted"]

Resource Status.

One of the following:

"active"

"deleting"

"deleted"

Resource SharingRecipients

List share recipients by share ID

resource_sharing.recipients.list(strshare_id, RecipientListParams**kwargs) -> SyncV4PagePaginationArray[RecipientListResponse]

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

Get share recipient by ID

resource_sharing.recipients.get(strrecipient_id, RecipientGetParams**kwargs) -> RecipientGetResponse

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

Create a new share recipient

resource_sharing.recipients.create(strshare_id, RecipientCreateParams**kwargs) -> RecipientCreateResponse

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

Delete a share recipient

resource_sharing.recipients.delete(strrecipient_id, RecipientDeleteParams**kwargs) -> RecipientDeleteResponse

DELETE/accounts/{account_id}/shares/{share_id}/recipients/{recipient_id}

ModelsExpand Collapse

class RecipientListResponse: …

id: str

Share Recipient identifier tag.

maxLength32

account_id: str

Account identifier.

maxLength32

association_status: Literal["associating", "associated", "disassociating", "disassociated"]

Share Recipient association status.

One of the following:

"associating"

"associated"

"disassociating"

"disassociated"

created: datetime

When the share was created.

formatdate-time

modified: datetime

When the share was modified.

formatdate-time

resources: Optional[List[Resource]]

error: str

Share Recipient error message.

resource_id: str

Share Resource identifier.

maxLength32

resource_version: int

Resource Version.

terminal: bool

Whether the error is terminal or will be continually retried.

class RecipientGetResponse: …

id: str

Share Recipient identifier tag.

maxLength32

account_id: str

Account identifier.

maxLength32

association_status: Literal["associating", "associated", "disassociating", "disassociated"]

Share Recipient association status.

One of the following:

"associating"

"associated"

"disassociating"

"disassociated"

created: datetime

When the share was created.

formatdate-time

modified: datetime

When the share was modified.

formatdate-time

resources: Optional[List[Resource]]

error: str

Share Recipient error message.

resource_id: str

Share Resource identifier.

maxLength32

resource_version: int

Resource Version.

terminal: bool

Whether the error is terminal or will be continually retried.

class RecipientCreateResponse: …

id: str

Share Recipient identifier tag.

maxLength32

account_id: str

Account identifier.

maxLength32

association_status: Literal["associating", "associated", "disassociating", "disassociated"]

Share Recipient association status.

One of the following:

"associating"

"associated"

"disassociating"

"disassociated"

created: datetime

When the share was created.

formatdate-time

modified: datetime

When the share was modified.

formatdate-time

resources: Optional[List[Resource]]

error: str

Share Recipient error message.

resource_id: str

Share Resource identifier.

maxLength32

resource_version: int

Resource Version.

terminal: bool

Whether the error is terminal or will be continually retried.

class RecipientDeleteResponse: …

id: str

Share Recipient identifier tag.

maxLength32

account_id: str

Account identifier.

maxLength32

association_status: Literal["associating", "associated", "disassociating", "disassociated"]

Share Recipient association status.

One of the following:

"associating"

"associated"

"disassociating"

"disassociated"

created: datetime

When the share was created.

formatdate-time

modified: datetime

When the share was modified.

formatdate-time

resources: Optional[List[Resource]]

error: str

Share Recipient error message.

resource_id: str

Share Resource identifier.

maxLength32

resource_version: int

Resource Version.

terminal: bool

Whether the error is terminal or will be continually retried.

Resource SharingResources

List share resources by share ID

resource_sharing.resources.list(strshare_id, ResourceListParams**kwargs) -> SyncV4PagePaginationArray[ResourceListResponse]

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

Get share resource by ID

resource_sharing.resources.get(strresource_id, ResourceGetParams**kwargs) -> ResourceGetResponse

GET/accounts/{account_id}/shares/{share_id}/resources/{resource_id}

Create a new share resource

resource_sharing.resources.create(strshare_id, ResourceCreateParams**kwargs) -> ResourceCreateResponse

POST/accounts/{account_id}/shares/{share_id}/resources

Update a share resource

resource_sharing.resources.update(strresource_id, ResourceUpdateParams**kwargs) -> ResourceUpdateResponse

PUT/accounts/{account_id}/shares/{share_id}/resources/{resource_id}

Delete a share resource

resource_sharing.resources.delete(strresource_id, ResourceDeleteParams**kwargs) -> ResourceDeleteResponse

DELETE/accounts/{account_id}/shares/{share_id}/resources/{resource_id}

ModelsExpand Collapse

class ResourceListResponse: …

id: str

Share Resource identifier.

maxLength32

created: datetime

When the share was created.

formatdate-time

meta: object

Resource Metadata.

modified: datetime

When the share was modified.

formatdate-time

resource_account_id: str

Account identifier.

maxLength32

resource_id: str

Share Resource identifier.

maxLength32

resource_type: Literal["custom-ruleset", "gateway-policy", "gateway-destination-ip", 2 more]

Resource Type.

One of the following:

"custom-ruleset"

"gateway-policy"

"gateway-destination-ip"

"gateway-block-page-settings"

"gateway-extended-email-matching"

resource_version: int

Resource Version.

status: Literal["active", "deleting", "deleted"]

Resource Status.

One of the following:

"active"

"deleting"

"deleted"

class ResourceGetResponse: …

id: str

Share Resource identifier.

maxLength32

created: datetime

When the share was created.

formatdate-time

meta: object

Resource Metadata.

modified: datetime

When the share was modified.

formatdate-time

resource_account_id: str

Account identifier.

maxLength32

resource_id: str

Share Resource identifier.

maxLength32

resource_type: Literal["custom-ruleset", "gateway-policy", "gateway-destination-ip", 2 more]

Resource Type.

One of the following:

"custom-ruleset"

"gateway-policy"

"gateway-destination-ip"

"gateway-block-page-settings"

"gateway-extended-email-matching"

resource_version: int

Resource Version.

status: Literal["active", "deleting", "deleted"]

Resource Status.

One of the following:

"active"

"deleting"

"deleted"

class ResourceCreateResponse: …

id: str

Share Resource identifier.

maxLength32

created: datetime

When the share was created.

formatdate-time

meta: object

Resource Metadata.

modified: datetime

When the share was modified.

formatdate-time

resource_account_id: str

Account identifier.

maxLength32

resource_id: str

Share Resource identifier.

maxLength32

resource_type: Literal["custom-ruleset", "gateway-policy", "gateway-destination-ip", 2 more]

Resource Type.

One of the following:

"custom-ruleset"

"gateway-policy"

"gateway-destination-ip"

"gateway-block-page-settings"

"gateway-extended-email-matching"

resource_version: int

Resource Version.

status: Literal["active", "deleting", "deleted"]

Resource Status.

One of the following:

"active"

"deleting"

"deleted"

class ResourceUpdateResponse: …

id: str

Share Resource identifier.

maxLength32

created: datetime

When the share was created.

formatdate-time

meta: object

Resource Metadata.

modified: datetime

When the share was modified.

formatdate-time

resource_account_id: str

Account identifier.

maxLength32

resource_id: str

Share Resource identifier.

maxLength32

resource_type: Literal["custom-ruleset", "gateway-policy", "gateway-destination-ip", 2 more]

Resource Type.

One of the following:

"custom-ruleset"

"gateway-policy"

"gateway-destination-ip"

"gateway-block-page-settings"

"gateway-extended-email-matching"

resource_version: int

Resource Version.

status: Literal["active", "deleting", "deleted"]

Resource Status.

One of the following:

"active"

"deleting"

"deleted"

class ResourceDeleteResponse: …

id: str

Share Resource identifier.

maxLength32

created: datetime

When the share was created.

formatdate-time

meta: object

Resource Metadata.

modified: datetime

When the share was modified.

formatdate-time

resource_account_id: str

Account identifier.

maxLength32

resource_id: str

Share Resource identifier.

maxLength32

resource_type: Literal["custom-ruleset", "gateway-policy", "gateway-destination-ip", 2 more]

Resource Type.

One of the following:

"custom-ruleset"

"gateway-policy"

"gateway-destination-ip"

"gateway-block-page-settings"

"gateway-extended-email-matching"

resource_version: int

Resource Version.

status: Literal["active", "deleting", "deleted"]

Resource Status.

One of the following:

"active"

"deleting"

"deleted"