Skip to content
This repository was archived by the owner on Nov 6, 2026. It is now read-only.

integration_mappings.md

Latest commit

 

History

History
308 lines (214 loc) · 10.3 KB

integration_mappings.md

File metadata and controls

308 lines (214 loc) · 10.3 KB
Raw

IntegrationMappingsManager

Caution

box-python-sdk-gen is deprecated and no longer maintained. As of September 17, 2025, it receives no new features, bug fixes, or security patches. Do not use it for new projects.

Use box-python-sdk v10+ instead: pip install "boxsdk>=10". The equivalent of this page is box-python-sdk/docs/integration_mappings.md. To migrate existing code, see the migration guide.

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 get_slack_integration_mapping.

See the endpoint docs at API Reference.

user_client.integration_mappings.get_slack_integration_mapping()

Arguments

  • marker Optional[str]
    • Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
  • limit Optional[int]
    • The maximum number of items to return per page.
  • partner_item_type Optional[GetSlackIntegrationMappingPartnerItemType]
    • Mapped item type, for which the mapping should be returned.
  • partner_item_id Optional[str]
    • ID of the mapped item, for which the mapping should be returned.
  • box_item_id Optional[str]
    • Box item ID, for which the mappings should be returned.
  • box_item_type Optional[GetSlackIntegrationMappingBoxItemType]
    • Box item type, for which the mappings should be returned.
  • is_manually_created Optional[bool]
    • Whether the mapping has been manually created.
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

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 create_slack_integration_mapping.

See the endpoint docs at API Reference.

user_client.integration_mappings.create_slack_integration_mapping(
    IntegrationMappingPartnerItemSlack(
        id=slack_partner_item_id, slack_org_id=slack_org_id
    ),
    IntegrationMappingBoxItemSlack(id=folder.id),
)

Arguments

  • partner_item IntegrationMappingPartnerItemSlack
  • box_item IntegrationMappingBoxItemSlack
  • options Optional[IntegrationMappingSlackOptions]
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

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 update_slack_integration_mapping_by_id.

See the endpoint docs at API Reference.

user_client.integration_mappings.update_slack_integration_mapping_by_id(
    slack_integration_mapping.id, box_item=IntegrationMappingBoxItemSlack(id=folder.id)
)

Arguments

  • integration_mapping_id str
    • An ID of an integration mapping. Example: "11235432"
  • box_item Optional[IntegrationMappingBoxItemSlack]
  • options Optional[IntegrationMappingSlackOptions]
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

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 delete_slack_integration_mapping_by_id.

See the endpoint docs at API Reference.

user_client.integration_mappings.delete_slack_integration_mapping_by_id(
    slack_integration_mapping.id
)

Arguments

  • integration_mapping_id str
    • An ID of an integration mapping. Example: "11235432"
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

Returns

This function returns a value of type None.

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 get_teams_integration_mapping.

See the endpoint docs at API Reference.

user_client.integration_mappings.get_teams_integration_mapping()

Arguments

  • partner_item_type Optional[GetTeamsIntegrationMappingPartnerItemType]
    • Mapped item type, for which the mapping should be returned.
  • partner_item_id Optional[str]
    • ID of the mapped item, for which the mapping should be returned.
  • box_item_id Optional[str]
    • Box item ID, for which the mappings should be returned.
  • box_item_type Optional[GetTeamsIntegrationMappingBoxItemType]
    • Box item type, for which the mappings should be returned.
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

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 create_teams_integration_mapping.

See the endpoint docs at API Reference.

user_client.integration_mappings.create_teams_integration_mapping(
    IntegrationMappingPartnerItemTeamsCreateRequest(
        type=IntegrationMappingPartnerItemTeamsCreateRequestTypeField.CHANNEL,
        id=partner_item_id,
        tenant_id=tenant_id,
        team_id=team_id,
    ),
    FolderReference(id=folder.id),
)

Arguments

  • partner_item IntegrationMappingPartnerItemTeamsCreateRequest
  • box_item FolderReference
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

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 update_teams_integration_mapping_by_id.

See the endpoint docs at API Reference.

user_client.integration_mappings.update_teams_integration_mapping_by_id(
    integration_mapping_id, box_item=FolderReference(id="1234567")
)

Arguments

  • integration_mapping_id str
    • An ID of an integration mapping. Example: "11235432"
  • box_item Optional[FolderReference]
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

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 delete_teams_integration_mapping_by_id.

See the endpoint docs at API Reference.

user_client.integration_mappings.delete_teams_integration_mapping_by_id(
    integration_mapping_id
)

Arguments

  • integration_mapping_id str
    • An ID of an integration mapping. Example: "11235432"
  • extra_headers Optional[Dict[str, Optional[str]]]
    • Extra headers that will be included in the HTTP request.

Returns

This function returns a value of type None.

Empty body in response.