API version 2025.0
A Box Hub collaboration object grants a user or group access
to a Box Hub with permissions defined by a specific role.
example: 12345678 The unique identifier for this collaboration.
example: hub_collaboration The value will always be hub_collaboration. Value is always hub_collaboration
acceptance_requirements_status
strong_password_requirement
enterprise_has_strong_password_required_for_external_users
example: true Whether or not the enterprise that owns the content requires
a strong password to collaborate on the content, or enforces
an exposed password detection for the external collaborators.
example: true Whether or not the user has a strong and not exposed password set
for their account. The field is null when a strong password is
not required.
terms_of_service_requirement
example: true Whether or not the terms of service have been accepted. The
field is null when there is no terms of service required.
The terms of service that must be accepted before the
collaboration can be accepted. The field is null when
there is no terms of service required. example: 11446498 The unique identifier for this terms of service.
example: terms_of_service The value will always be terms_of_service. Value is always terms_of_service
two_factor_authentication_requirement
enterprise_has_two_factor_auth_enabled
example: true Whether or not the enterprise that owns the content requires
two-factor authentication to be enabled in order to
collaborate on the content.
user_has_two_factor_authentication_enabled
example: true Whether or not the user has two-factor authentication
enabled. The field is null when two-factor
authentication is not required.
The user or group that is granted access.
The bare basic representation of a Box Hub.
example: editor The level of access granted to a Box Hub.
Possible values are editor, viewer, and co-owner.
example: accepted The status of the collaboration invitation. If the status
is pending, login and name return an empty string. Value is one of accepted,pending,rejected
{
"id" : "12345678" ,
"type" : "hub_collaboration" ,
"acceptance_requirements_status" : {
"strong_password_requirement" : {
"enterprise_has_strong_password_required_for_external_users" : true ,
"user_has_strong_password" : true
},
"terms_of_service_requirement" : {
"is_accepted" : true ,
"terms_of_service" : {
"id" : "11446498" ,
"type" : "terms_of_service"
}
},
"two_factor_authentication_requirement" : {
"enterprise_has_two_factor_auth_enabled" : true ,
"user_has_two_factor_authentication_enabled" : true
}
},
"accessible_by" : {
"id" : "11446498" ,
"type" : "user" ,
"login" : "[email protected] " ,
"name" : "Aaron Levie"
},
"hub" : {
"id" : "12345" ,
"type" : "hubs"
},
"role" : "editor" ,
"status" : "accepted"
}