Skip to content
Start here

Resources

List share resources by share ID
client.resourceSharing.resources.list(stringshareID, ResourceListParams { account_id, page, per_page, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray<ResourceListResponse { id, created, meta, 6 more } >
GET/accounts/{account_id}/shares/{share_id}/resources
Get share resource by ID
client.resourceSharing.resources.get(stringshareResourceID, ResourceGetParams { account_id, share_id } params, RequestOptionsoptions?): ResourceGetResponse { id, created, meta, 6 more }
GET/accounts/{account_id}/shares/{share_id}/resources/{share_resource_id}
Create a new share resource
client.resourceSharing.resources.create(stringshareID, ResourceCreateParams { account_id, meta, resource_account_id, 2 more } params, RequestOptionsoptions?): ResourceCreateResponse { id, created, meta, 6 more }
POST/accounts/{account_id}/shares/{share_id}/resources
Update a share resource
client.resourceSharing.resources.update(stringshareResourceID, ResourceUpdateParams { account_id, share_id, meta } params, RequestOptionsoptions?): ResourceUpdateResponse { id, created, meta, 6 more }
PUT/accounts/{account_id}/shares/{share_id}/resources/{share_resource_id}
Delete a share resource
client.resourceSharing.resources.delete(stringshareResourceID, ResourceDeleteParams { account_id, share_id } params, RequestOptionsoptions?): ResourceDeleteResponse { id, created, meta, 6 more }
DELETE/accounts/{account_id}/shares/{share_id}/resources/{share_resource_id}
ModelsExpand Collapse
ResourceListResponse { id, created, meta, 6 more }
id: string

Share Resource identifier.

maxLength32
created: string

When the share was created.

formatdate-time
meta: unknown

Resource Metadata.

modified: string

When the share was modified.

formatdate-time
resource_account_id: string

Account identifier.

maxLength32
resource_id: string

Share Resource identifier.

maxLength32
resource_type: "custom-ruleset" | "gateway-policy" | "gateway-destination-ip" | 3 more

Resource Type.

One of the following:
"custom-ruleset"
"gateway-policy"
"gateway-destination-ip"
"gateway-block-page-settings"
"gateway-extended-email-matching"
"idp-federation-grant"
resource_version: number

Resource Version.

status: "active" | "deleting" | "deleted"

Resource Status.

One of the following:
"active"
"deleting"
"deleted"
ResourceGetResponse { id, created, meta, 6 more }
id: string

Share Resource identifier.

maxLength32
created: string

When the share was created.

formatdate-time
meta: unknown

Resource Metadata.

modified: string

When the share was modified.

formatdate-time
resource_account_id: string

Account identifier.

maxLength32
resource_id: string

Share Resource identifier.

maxLength32
resource_type: "custom-ruleset" | "gateway-policy" | "gateway-destination-ip" | 3 more

Resource Type.

One of the following:
"custom-ruleset"
"gateway-policy"
"gateway-destination-ip"
"gateway-block-page-settings"
"gateway-extended-email-matching"
"idp-federation-grant"
resource_version: number

Resource Version.

status: "active" | "deleting" | "deleted"

Resource Status.

One of the following:
"active"
"deleting"
"deleted"
ResourceCreateResponse { id, created, meta, 6 more }
id: string

Share Resource identifier.

maxLength32
created: string

When the share was created.

formatdate-time
meta: unknown

Resource Metadata.

modified: string

When the share was modified.

formatdate-time
resource_account_id: string

Account identifier.

maxLength32
resource_id: string

Share Resource identifier.

maxLength32
resource_type: "custom-ruleset" | "gateway-policy" | "gateway-destination-ip" | 3 more

Resource Type.

One of the following:
"custom-ruleset"
"gateway-policy"
"gateway-destination-ip"
"gateway-block-page-settings"
"gateway-extended-email-matching"
"idp-federation-grant"
resource_version: number

Resource Version.

status: "active" | "deleting" | "deleted"

Resource Status.

One of the following:
"active"
"deleting"
"deleted"
ResourceUpdateResponse { id, created, meta, 6 more }
id: string

Share Resource identifier.

maxLength32
created: string

When the share was created.

formatdate-time
meta: unknown

Resource Metadata.

modified: string

When the share was modified.

formatdate-time
resource_account_id: string

Account identifier.

maxLength32
resource_id: string

Share Resource identifier.

maxLength32
resource_type: "custom-ruleset" | "gateway-policy" | "gateway-destination-ip" | 3 more

Resource Type.

One of the following:
"custom-ruleset"
"gateway-policy"
"gateway-destination-ip"
"gateway-block-page-settings"
"gateway-extended-email-matching"
"idp-federation-grant"
resource_version: number

Resource Version.

status: "active" | "deleting" | "deleted"

Resource Status.

One of the following:
"active"
"deleting"
"deleted"
ResourceDeleteResponse { id, created, meta, 6 more }
id: string

Share Resource identifier.

maxLength32
created: string

When the share was created.

formatdate-time
meta: unknown

Resource Metadata.

modified: string

When the share was modified.

formatdate-time
resource_account_id: string

Account identifier.

maxLength32
resource_id: string

Share Resource identifier.

maxLength32
resource_type: "custom-ruleset" | "gateway-policy" | "gateway-destination-ip" | 3 more

Resource Type.

One of the following:
"custom-ruleset"
"gateway-policy"
"gateway-destination-ip"
"gateway-block-page-settings"
"gateway-extended-email-matching"
"idp-federation-grant"
resource_version: number

Resource Version.

status: "active" | "deleting" | "deleted"

Resource Status.

One of the following:
"active"
"deleting"
"deleted"