POST /api/role/{workspace_id}/

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.

Servers

/

Path parameters

Name	Type	Required	Description
`workspace_id`	Integer	Yes	The workspace in which the role assignment takes place.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`scope_type`	String	Yes	The scope object type. `core` - core `application` - application `workspace` - workspace `workspace_invitation` - workspace_invitation `snapshot` - snapshot `workspace_user` - workspace_user `integration` - integration `user_source` - user_source `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 `team` - team `team_subject` - team_subject `license` - license Possible values: `"builder_workflow_action"` `"dashboard"` `"dashboard_data_source"` `"user_source"` `"builder_data_source"` `"builder_element"` `"workspace"` `"builder_page"` `"database_view_filter_group"` `"database_view_group"` `"builder_domain"` `"team"` `"license"` `"database_view_filter"` `"builder"` `"database_view_sort"` `"snapshot"` `"database_view"` `"database"` `"database_table"` `"database_view_decoration"` `"workspace_invitation"` `"team_subject"` `"core"` `"workspace_user"` `"dashboard_widget"` `"application"` `"integration"` `"database_field"` `"token"`
`scope_id`	Integer	Yes	The ID of the scope object. The scope object limit the role assignment to this scope and all its descendants.
`subject_type`	String	Yes	The subject type. `auth.User` - auth.User `anonymous` - anonymous `user_source.user` - user_source.user `core.Token` - core.Token `baserow_enterprise.Team` - baserow_enterprise.Team Possible values: `"core.Token"` `"baserow_enterprise.Team"` `"user_source.user"` `"auth.User"` `"anonymous"`
`subject_id`	Integer	Yes	The subject ID. A subject is an actor that can do operations.
`role`	String	Yes	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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.