Skip to content

Latest commit

 

History

History
129 lines (78 loc) · 4 KB

collaborationallowlistentries.md

File metadata and controls

129 lines (78 loc) · 4 KB

CollaborationAllowlistEntriesManager

List allowed collaboration domains

Returns the list domains that have been deemed safe to create collaborations for within the current enterprise.

This operation is performed by calling function getCollaborationWhitelistEntries.

See the endpoint docs at API Reference.

client.getCollaborationAllowlistEntries().getCollaborationWhitelistEntries()

Arguments

  • queryParams GetCollaborationWhitelistEntriesQueryParams
    • Query parameters of getCollaborationWhitelistEntries method
  • headers GetCollaborationWhitelistEntriesHeaders
    • Headers of getCollaborationWhitelistEntries method

Returns

This function returns a value of type CollaborationAllowlistEntries.

Returns a collection of domains that are allowed for collaboration.

Add domain to list of allowed collaboration domains

Creates a new entry in the list of allowed domains to allow collaboration for.

This operation is performed by calling function createCollaborationWhitelistEntry.

See the endpoint docs at API Reference.

client.getCollaborationAllowlistEntries().createCollaborationWhitelistEntry(new CreateCollaborationWhitelistEntryRequestBody(domain, CreateCollaborationWhitelistEntryRequestBodyDirectionField.INBOUND))

Arguments

  • requestBody CreateCollaborationWhitelistEntryRequestBody
    • Request body of createCollaborationWhitelistEntry method
  • headers CreateCollaborationWhitelistEntryHeaders
    • Headers of createCollaborationWhitelistEntry method

Returns

This function returns a value of type CollaborationAllowlistEntry.

Returns a new entry on the list of allowed domains.

Get allowed collaboration domain

Returns a domain that has been deemed safe to create collaborations for within the current enterprise.

This operation is performed by calling function getCollaborationWhitelistEntryById.

See the endpoint docs at API Reference.

client.getCollaborationAllowlistEntries().getCollaborationWhitelistEntryById(newEntry.getId())

Arguments

  • collaborationWhitelistEntryId String
    • The ID of the entry in the list. Example: "213123"
  • headers GetCollaborationWhitelistEntryByIdHeaders
    • Headers of getCollaborationWhitelistEntryById method

Returns

This function returns a value of type CollaborationAllowlistEntry.

Returns an entry on the list of allowed domains.

Remove domain from list of allowed collaboration domains

Removes a domain from the list of domains that have been deemed safe to create collaborations for within the current enterprise.

This operation is performed by calling function deleteCollaborationWhitelistEntryById.

See the endpoint docs at API Reference.

client.getCollaborationAllowlistEntries().deleteCollaborationWhitelistEntryById(entry.getId())

Arguments

  • collaborationWhitelistEntryId String
    • The ID of the entry in the list. Example: "213123"
  • headers DeleteCollaborationWhitelistEntryByIdHeaders
    • Headers of deleteCollaborationWhitelistEntryById method

Returns

This function returns a value of type void.

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