box-node-sdk

CollaborationAllowlistExemptTargetsManager

• List users exempt from collaboration domain restrictions
• Create user exemption from collaboration domain restrictions
• Get user exempt from collaboration domain restrictions
• Remove user from list of users exempt from domain restrictions

List users exempt from collaboration domain restrictions

Returns a list of users who have been exempt from the collaboration domain restrictions.

This operation is performed by calling function getCollaborationWhitelistExemptTargets.

See the endpoint docs at API Reference.

await client.collaborationAllowlistExemptTargets.getCollaborationWhitelistExemptTargets();

Arguments

• queryParams GetCollaborationWhitelistExemptTargetsQueryParams
  • Query parameters of getCollaborationWhitelistExemptTargets method
• headersInput GetCollaborationWhitelistExemptTargetsHeadersInput
  • Headers of getCollaborationWhitelistExemptTargets method
• cancellationToken undefined | CancellationToken
  • Token used for request cancellation.

Returns

This function returns a value of type CollaborationAllowlistExemptTargets.

Returns a collection of user exemptions.

Create user exemption from collaboration domain restrictions

Exempts a user from the restrictions set out by the allowed list of domains for collaborations.

This operation is performed by calling function createCollaborationWhitelistExemptTarget.

See the endpoint docs at API Reference.

await client.collaborationAllowlistExemptTargets.createCollaborationWhitelistExemptTarget(
  {
    user: {
      id: user.id,
    } satisfies CreateCollaborationWhitelistExemptTargetRequestBodyUserField,
  } satisfies CreateCollaborationWhitelistExemptTargetRequestBody,
);

Arguments

• requestBody CreateCollaborationWhitelistExemptTargetRequestBody
  • Request body of createCollaborationWhitelistExemptTarget method
• optionalsInput CreateCollaborationWhitelistExemptTargetOptionalsInput

Returns

This function returns a value of type CollaborationAllowlistExemptTarget.

Returns a new exemption entry.

Get user exempt from collaboration domain restrictions

Returns a users who has been exempt from the collaboration domain restrictions.

This operation is performed by calling function getCollaborationWhitelistExemptTargetById.

See the endpoint docs at API Reference.

await client.collaborationAllowlistExemptTargets.getCollaborationWhitelistExemptTargetById(
  newExemptTarget.id!,
);

Arguments

• collaborationWhitelistExemptTargetId string
  • The ID of the exemption to the list. Example: “984923”
• optionalsInput GetCollaborationWhitelistExemptTargetByIdOptionalsInput

Returns

This function returns a value of type CollaborationAllowlistExemptTarget.

Returns the user’s exempted from the list of collaboration domains.

Remove user from list of users exempt from domain restrictions

Removes a user’s exemption from the restrictions set out by the allowed list of domains for collaborations.

This operation is performed by calling function deleteCollaborationWhitelistExemptTargetById.

See the endpoint docs at API Reference.

await client.collaborationAllowlistExemptTargets.deleteCollaborationWhitelistExemptTargetById(
  exemptTarget.id!,
);

Arguments

• collaborationWhitelistExemptTargetId string
  • The ID of the exemption to the list. Example: “984923”
• optionalsInput DeleteCollaborationWhitelistExemptTargetByIdOptionalsInput

Returns

This function returns a value of type undefined.

A blank response is returned if the exemption was successfully deleted.

This site is open source. Improve this page.