API ReferenceOrganizations

✨ Update default role

<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> Update the default role for members of a specific organization.

Authentication

Authorizationstring
The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Path parameters

idintegerRequired

Request

This endpoint expects an object.
annotator_reviewer_firewall_enabled_atdatetime or nullOptional

Set to current time to restrict data sharing between annotators and reviewers in the label stream, review stream, and notifications (which will be disabled). In these settings, information about annotator and reviewer identity is suppressed in the UI.

custom_scripts_enabled_atdatetime or nullOptional

Set to current time to enable custom scripts (Plugins) for this organization. Can only be enabled if no organization members are active members of any other organizations; otherwise an error will be raised. If this occurs, contact the LEAP team for assistance with enabling custom scripts (Plugins).

default_roleenumOptional
Default membership role for invited users * `OW` - Owner * `AD` - Administrator * `MA` - Manager * `RE` - Reviewer * `AN` - Annotator * `DI` - Deactivated * `NO` - Not Activated
email_notification_settingsany or nullOptional

Email notification settings for this organization. Controls which email notifications users can receive. Structure: {“notifications_allowed”: {“notification_type”: bool}}

embed_domainsany or nullOptional

List of objects: {“domain”: “example.com”}. Used for CSP header on /embed routes.

embed_settingsany or nullOptional
Embed settings for this organization
external_idstring or nullOptional
External ID to uniquely identify this organization
extra_data_on_activity_logsbooleanOptional
label_stream_navigation_disabled_atdatetime or nullOptional
Set to current time to disable the label stream navigation for this organization. This will prevent users from going back in the label stream to view previous labels.
organizationintegerOptional
A unique integer value identifying this organization.
read_only_quick_view_enabled_atdatetime or nullOptional
Set to current time to prevent creating or editing annotations in quick view.

Response

organizationinteger
A unique integer value identifying this organization.
annotator_reviewer_firewall_enabled_atdatetime or null

Set to current time to restrict data sharing between annotators and reviewers in the label stream, review stream, and notifications (which will be disabled). In these settings, information about annotator and reviewer identity is suppressed in the UI.

custom_scripts_enabled_atdatetime or null

Set to current time to enable custom scripts (Plugins) for this organization. Can only be enabled if no organization members are active members of any other organizations; otherwise an error will be raised. If this occurs, contact the LEAP team for assistance with enabling custom scripts (Plugins).

default_roleenum or null
Default membership role for invited users * `OW` - Owner * `AD` - Administrator * `MA` - Manager * `RE` - Reviewer * `AN` - Annotator * `DI` - Deactivated * `NO` - Not Activated
email_notification_settingsany or null

Email notification settings for this organization. Controls which email notifications users can receive. Structure: {“notifications_allowed”: {“notification_type”: bool}}

embed_domainsany or null

List of objects: {“domain”: “example.com”}. Used for CSP header on /embed routes.

embed_settingsany or null
Embed settings for this organization
external_idstring or null
External ID to uniquely identify this organization
extra_data_on_activity_logsboolean or null
label_stream_navigation_disabled_atdatetime or null
Set to current time to disable the label stream navigation for this organization. This will prevent users from going back in the label stream to view previous labels.
read_only_quick_view_enabled_atdatetime or null
Set to current time to prevent creating or editing annotations in quick view.