Organizations

✨ Update default role

Changed on
<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.
patch/api/organizations/{id}/set-default-role

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/organizations/{id}/set-default-role
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Request body

annotator_reviewer_firewall_enabled_atstring date-time nullable

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_interfaces_enabledboolean nullable

Enable custom interfaces for this organization. When disabled, projects with use_custom_interface=True will not render custom interfaces anywhere in the product (label stream, embed, data manager, interfaces dashboard).

custom_scripts_enabled_atstring date-time nullable

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_role'OW' | 'AD' | 'MA' | 'RE' | 'AN' | 'DI' | 'NO' | 'VO'
  • OW - Owner
  • AD - Administrator
  • MA - Manager
  • RE - Reviewer
  • AN - Annotator
  • DI - Deactivated
  • NO - Not Activated
  • VO - View Only
email_notification_settingsunknown
embed_domainsunknown
embed_enabledboolean nullable

Enable embed functionality for this organization

embed_settingsunknown
external_idstring nullable

External ID to uniquely identify this organization

extra_data_on_activity_logsboolean
interface_settingsunknown
label_stream_navigation_disabled_atstring date-time nullable

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.

organizationinteger

A unique integer value identifying this organization.

react_code_settingsunknown
read_only_quick_view_enabled_atstring date-time nullable

Set to current time to prevent creating or editing annotations in quick view.

Response

annotator_reviewer_firewall_enabled_atstring date-time nullable

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_interfaces_enabledboolean nullable

Enable custom interfaces for this organization. When disabled, projects with use_custom_interface=True will not render custom interfaces anywhere in the product (label stream, embed, data manager, interfaces dashboard).

custom_scripts_enabled_atstring date-time nullable

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_role'OW' | 'AD' | 'MA' | 'RE' | 'AN' | 'DI' | 'NO' | 'VO'
  • OW - Owner
  • AD - Administrator
  • MA - Manager
  • RE - Reviewer
  • AN - Annotator
  • DI - Deactivated
  • NO - Not Activated
  • VO - View Only
email_notification_settingsunknown
embed_domainsunknown
embed_enabledboolean nullable

Enable embed functionality for this organization

embed_settingsunknown
external_idstring nullable

External ID to uniquely identify this organization

extra_data_on_activity_logsboolean
interface_settingsunknown
label_stream_navigation_disabled_atstring date-time nullable

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.

organizationinteger required

A unique integer value identifying this organization.

react_code_settingsunknown
read_only_quick_view_enabled_atstring date-time nullable

Set to current time to prevent creating or editing annotations in quick view.

Changes

    • warning

      added the new VO enum value to the //// response property for the response status

    • info

      added the new VO enum value to the request property //// (media type: application/json)

    • info

      added the new VO enum value to the request property //// (media type: application/x-www-form-urlencoded)

    • info

      added the new VO enum value to the request property //// (media type: multipart/form-data)

    • breaking

      added to the request property allOf list (media type: application/json)

    • breaking

      added to the request property allOf list (media type: application/x-www-form-urlencoded)

    • breaking

      added to the request property allOf list (media type: multipart/form-data)

    • warning

      removed from the request property allOf list (media type: application/json)

    • warning

      removed from the request property allOf list (media type: application/x-www-form-urlencoded)

    • warning

      removed from the request property allOf list (media type: multipart/form-data)

    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status