integrationmappings.md

IntegrationMappingsManager

• List Slack integration mappings
• Create Slack integration mapping
• Update Slack integration mapping
• Delete Slack integration mapping
• List Teams integration mappings
• Create Teams integration mapping
• Update Teams integration mapping
• Delete Teams integration mapping

List Slack integration mappings

Lists Slack integration mappings in a users' enterprise.

You need Admin or Co-Admin role to use this endpoint.

This operation is performed by calling function getSlackIntegrationMapping.

See the endpoint docs at API Reference.

userClient.getIntegrationMappings().getSlackIntegrationMapping()

Arguments

• queryParams GetSlackIntegrationMappingQueryParams
  • Query parameters of getSlackIntegrationMapping method
• headers GetSlackIntegrationMappingHeaders
  • Headers of getSlackIntegrationMapping method

Returns

This function returns a value of type IntegrationMappings.

Returns a collection of integration mappings

Create Slack integration mapping

Creates a Slack integration mapping by mapping a Slack channel to a Box item.

You need Admin or Co-Admin role to use this endpoint.

This operation is performed by calling function createSlackIntegrationMapping.

See the endpoint docs at API Reference.

userClient.getIntegrationMappings().createSlackIntegrationMapping(new IntegrationMappingSlackCreateRequest(new IntegrationMappingPartnerItemSlack.IntegrationMappingPartnerItemSlackBuilder(partnerItemId).slackOrgId(slackOrgId).build(), new IntegrationMappingBoxItemSlack(folder.getId())))

Arguments

• requestBody IntegrationMappingSlackCreateRequest
  • Request body of createSlackIntegrationMapping method
• headers CreateSlackIntegrationMappingHeaders
  • Headers of createSlackIntegrationMapping method

Returns

This function returns a value of type IntegrationMapping.

Returns the created integration mapping.

Update Slack integration mapping

Updates a Slack integration mapping. Supports updating the Box folder ID and options.

You need Admin or Co-Admin role to use this endpoint.

This operation is performed by calling function updateSlackIntegrationMappingById.

See the endpoint docs at API Reference.

userClient.getIntegrationMappings().updateSlackIntegrationMappingById(integrationMappingId, new UpdateSlackIntegrationMappingByIdRequestBody.UpdateSlackIntegrationMappingByIdRequestBodyBuilder().boxItem(new IntegrationMappingBoxItemSlack("1234567")).build())

Arguments

• integrationMappingId String
  • An ID of an integration mapping Example: "11235432"
• requestBody UpdateSlackIntegrationMappingByIdRequestBody
  • Request body of updateSlackIntegrationMappingById method
• headers UpdateSlackIntegrationMappingByIdHeaders
  • Headers of updateSlackIntegrationMappingById method

Returns

This function returns a value of type IntegrationMapping.

Returns the updated integration mapping object.

Delete Slack integration mapping

Deletes a Slack integration mapping.

You need Admin or Co-Admin role to use this endpoint.

This operation is performed by calling function deleteSlackIntegrationMappingById.

See the endpoint docs at API Reference.

userClient.getIntegrationMappings().deleteSlackIntegrationMappingById(integrationMappingId)

Arguments

• integrationMappingId String
  • An ID of an integration mapping Example: "11235432"
• headers DeleteSlackIntegrationMappingByIdHeaders
  • Headers of deleteSlackIntegrationMappingById method

Returns

This function returns a value of type void.

Empty body in response

List Teams integration mappings

Lists Teams integration mappings in a users' enterprise. You need Admin or Co-Admin role to use this endpoint.

This operation is performed by calling function getTeamsIntegrationMapping.

See the endpoint docs at API Reference.

userClient.getIntegrationMappings().getTeamsIntegrationMapping()

Arguments

• queryParams GetTeamsIntegrationMappingQueryParams
  • Query parameters of getTeamsIntegrationMapping method
• headers GetTeamsIntegrationMappingHeaders
  • Headers of getTeamsIntegrationMapping method

Returns

This function returns a value of type IntegrationMappingsTeams.

Returns a collection of integration mappings

Create Teams integration mapping

Creates a Teams integration mapping by mapping a Teams channel to a Box item. You need Admin or Co-Admin role to use this endpoint.

This operation is performed by calling function createTeamsIntegrationMapping.

See the endpoint docs at API Reference.

userClient.getIntegrationMappings().createTeamsIntegrationMapping(new IntegrationMappingTeamsCreateRequest(new IntegrationMappingPartnerItemTeamsCreateRequest(IntegrationMappingPartnerItemTeamsCreateRequestTypeField.CHANNEL, partnerItemId, tenantId, teamId), new FolderReference(folder.getId())))

Arguments

• requestBody IntegrationMappingTeamsCreateRequest
  • Request body of createTeamsIntegrationMapping method
• headers CreateTeamsIntegrationMappingHeaders
  • Headers of createTeamsIntegrationMapping method

Returns

This function returns a value of type IntegrationMappingTeams.

Returns the created integration mapping.

Update Teams integration mapping

Updates a Teams integration mapping. Supports updating the Box folder ID and options. You need Admin or Co-Admin role to use this endpoint.

This operation is performed by calling function updateTeamsIntegrationMappingById.

See the endpoint docs at API Reference.

userClient.getIntegrationMappings().updateTeamsIntegrationMappingById(integrationMappingId, new UpdateTeamsIntegrationMappingByIdRequestBody.UpdateTeamsIntegrationMappingByIdRequestBodyBuilder().boxItem(new FolderReference("1234567")).build())

Arguments

• integrationMappingId String
  • An ID of an integration mapping Example: "11235432"
• requestBody UpdateTeamsIntegrationMappingByIdRequestBody
  • Request body of updateTeamsIntegrationMappingById method
• headers UpdateTeamsIntegrationMappingByIdHeaders
  • Headers of updateTeamsIntegrationMappingById method

Returns

This function returns a value of type IntegrationMappingTeams.

Returns the updated integration mapping object.

Delete Teams integration mapping

Deletes a Teams integration mapping. You need Admin or Co-Admin role to use this endpoint.

This operation is performed by calling function deleteTeamsIntegrationMappingById.

See the endpoint docs at API Reference.

userClient.getIntegrationMappings().deleteTeamsIntegrationMappingById(integrationMappingId)

Arguments

• integrationMappingId String
  • An ID of an integration mapping Example: "11235432"
• headers DeleteTeamsIntegrationMappingByIdHeaders
  • Headers of deleteTeamsIntegrationMappingById method

Returns

This function returns a value of type void.

Empty body in response