v3

latestOpenAPI 3.0.3MIT2026-07-313881,2455.6 MB
Role assignments

You can assign a role to a subject into the given workspace for the given scope with this endpoint. If you want to remove the role you can omit the role property.

post/api/role/{workspace_id}/

Path parameters

workspace_idinteger required

The workspace in which the role assignment takes place.

Request body

subject_idinteger required

The subject ID. A subject is an actor that can do operations.

subject_type'auth.User' | 'anonymous' | 'user_source.user' | 'core.Token' | 'baserow_enterprise.Team' required
  • auth.User - auth.User
  • anonymous - anonymous
  • user_source.user - user_source.user
  • core.Token - core.Token
  • baserow_enterprise.Team - baserow_enterprise.Team
rolestring nullable required

The uid of the role you want to assign to the user or team in the given workspace. You can omit this property if you want to remove the role.

scope_idinteger required

The ID of the scope object. The scope object limit the role assignment to this scope and all its descendants.

scope_type'core' | 'application' | 'workspace' | 'workspace_invitation' | 'snapshot' | 'workspace_user' | 'integration' | 'user_source' | 'mcp_endpoint' | 'database' | 'database_table' | 'database_field' | 'database_view' | 'database_view_decoration' | 'database_view_sort' | 'database_view_group' | 'database_view_filter' | 'database_view_filter_group' | 'token' | 'builder' | 'builder_page' | 'builder_element' | 'builder_domain' | 'builder_data_source' | 'builder_workflow_action' | 'dashboard' | 'dashboard_data_source' | 'dashboard_widget' | 'automation' | 'automation_workflow' | 'automation_node' | 'team' | 'team_subject' | 'license' required
  • core - core
  • application - application
  • workspace - workspace
  • workspace_invitation - workspace_invitation
  • snapshot - snapshot
  • workspace_user - workspace_user
  • integration - integration
  • user_source - user_source
  • mcp_endpoint - mcp_endpoint
  • database - database
  • database_table - database_table
  • database_field - database_field
  • database_view - database_view
  • database_view_decoration - database_view_decoration
  • database_view_sort - database_view_sort
  • database_view_group - database_view_group
  • database_view_filter - database_view_filter
  • database_view_filter_group - database_view_filter_group
  • token - token
  • builder - builder
  • builder_page - builder_page
  • builder_element - builder_element
  • builder_domain - builder_domain
  • builder_data_source - builder_data_source
  • builder_workflow_action - builder_workflow_action
  • dashboard - dashboard
  • dashboard_data_source - dashboard_data_source
  • dashboard_widget - dashboard_widget
  • automation - automation
  • automation_workflow - automation_workflow
  • automation_node - automation_node
  • team - team
  • team_subject - team_subject
  • license - license

Response

idinteger required
rolestring required

The uid of the role assigned to the user or team in the given workspace.

subject_idinteger required

The subject ID.

scope_idinteger required

The unique scope ID.

subject_type'auth.User' | 'anonymous' | 'user_source.user' | 'core.Token' | 'baserow_enterprise.Team' required
  • auth.User - auth.User
  • anonymous - anonymous
  • user_source.user - user_source.user
  • core.Token - core.Token
  • baserow_enterprise.Team - baserow_enterprise.Team
scope_type'core' | 'application' | 'workspace' | 'workspace_invitation' | 'snapshot' | 'workspace_user' | 'integration' | 'user_source' | 'mcp_endpoint' | 'database' | 'database_table' | 'database_field' | 'database_view' | 'database_view_decoration' | 'database_view_sort' | 'database_view_group' | 'database_view_filter' | 'database_view_filter_group' | 'token' | 'builder' | 'builder_page' | 'builder_element' | 'builder_domain' | 'builder_data_source' | 'builder_workflow_action' | 'dashboard' | 'dashboard_data_source' | 'dashboard_widget' | 'automation' | 'automation_workflow' | 'automation_node' | 'team' | 'team_subject' | 'license' required
  • core - core
  • application - application
  • workspace - workspace
  • workspace_invitation - workspace_invitation
  • snapshot - snapshot
  • workspace_user - workspace_user
  • integration - integration
  • user_source - user_source
  • mcp_endpoint - mcp_endpoint
  • database - database
  • database_table - database_table
  • database_field - database_field
  • database_view - database_view
  • database_view_decoration - database_view_decoration
  • database_view_sort - database_view_sort
  • database_view_group - database_view_group
  • database_view_filter - database_view_filter
  • database_view_filter_group - database_view_filter_group
  • token - token
  • builder - builder
  • builder_page - builder_page
  • builder_element - builder_element
  • builder_domain - builder_domain
  • builder_data_source - builder_data_source
  • builder_workflow_action - builder_workflow_action
  • dashboard - dashboard
  • dashboard_data_source - dashboard_data_source
  • dashboard_widget - dashboard_widget
  • automation - automation
  • automation_workflow - automation_workflow
  • automation_node - automation_node
  • team - team
  • team_subject - team_subject
  • license - license