Organizations

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

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
{"stackTrail":"components:schemas:PatchedDefaultRoleRequest:properties:email_notification_settings","oasType":"schema","type":"unknown","description":"Email notification settings for this organization. Controls which email notifications users can receive. Structure: {\"notifications_allowed\": {\"notification_type\": bool}}","nullable":true}
{"stackTrail":"components:schemas:PatchedDefaultRoleRequest:properties:embed_domains","oasType":"schema","type":"unknown","description":"List of objects: {\"domain\": \"example.com\"}. Used for CSP header on /embed routes.","nullable":true}
embed_enabledboolean nullable

Enable embed functionality for this organization

{"stackTrail":"components:schemas:PatchedDefaultRoleRequest:properties:embed_settings","oasType":"schema","type":"unknown","description":"Embed settings for this organization","nullable":true}
external_idstring nullable

External ID to uniquely identify this organization

extra_data_on_activity_logsboolean
{"stackTrail":"components:schemas:PatchedDefaultRoleRequest:properties:interface_settings","oasType":"schema","type":"unknown","description":"Security settings for custom interfaces: CSP allowlists, script origins, iframe permissions.","nullable":true}
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.

{"stackTrail":"components:schemas:PatchedDefaultRoleRequest:properties:react_code_settings","oasType":"schema","type":"unknown","title":"ReactCode settings","description":"ReactCode tag security settings. Structure: {\"mode\": \"disabled\"|\"src_only\"|\"everything\", \"allowed_origins\": [\"https://...\"], \"allowed_permissions\": [\"camera\", ...]}","nullable":true}
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
{"stackTrail":"components:schemas:DefaultRole:properties:email_notification_settings","oasType":"schema","type":"unknown","description":"Email notification settings for this organization. Controls which email notifications users can receive. Structure: {\"notifications_allowed\": {\"notification_type\": bool}}","nullable":true}
{"stackTrail":"components:schemas:DefaultRole:properties:embed_domains","oasType":"schema","type":"unknown","description":"List of objects: {\"domain\": \"example.com\"}. Used for CSP header on /embed routes.","nullable":true}
embed_enabledboolean nullable

Enable embed functionality for this organization

{"stackTrail":"components:schemas:DefaultRole:properties:embed_settings","oasType":"schema","type":"unknown","description":"Embed settings for this organization","nullable":true}
external_idstring nullable

External ID to uniquely identify this organization

extra_data_on_activity_logsboolean
{"stackTrail":"components:schemas:DefaultRole:properties:interface_settings","oasType":"schema","type":"unknown","description":"Security settings for custom interfaces: CSP allowlists, script origins, iframe permissions.","nullable":true}
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.

{"stackTrail":"components:schemas:DefaultRole:properties:react_code_settings","oasType":"schema","type":"unknown","title":"ReactCode settings","description":"ReactCode tag security settings. Structure: {\"mode\": \"disabled\"|\"src_only\"|\"everything\", \"allowed_origins\": [\"https://...\"], \"allowed_permissions\": [\"camera\", ...]}","nullable":true}
read_only_quick_view_enabled_atstring date-time nullable

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

Changes

Changed in 3 of the 97 revisions of this API.3417

  • d61bc77f80bc13See the full diff
    • added the new VO enum value to the default_role/allOf[OrganizationRoleEnum]/ response property for the response status 200

      response-property-enum-value-added

    • added the new VO enum value to the request property default_role/allOf[OrganizationRoleEnum]/ (media type: application/json)

      request-property-enum-value-added

    • added the new VO enum value to the request property default_role/allOf[OrganizationRoleEnum]/ (media type: application/x-www-form-urlencoded)

      request-property-enum-value-added

    • added the new VO enum value to the request property default_role/allOf[OrganizationRoleEnum]/ (media type: multipart/form-data)

      request-property-enum-value-added

  • 04ff286141b5332See the full diff
    • added OrganizationRoleEnum to the default_role request property allOf list (media type: application/json)

      request-property-all-of-added

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

      request-property-all-of-added

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

      request-property-all-of-added

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

      request-property-all-of-removed

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

      request-property-all-of-removed

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

      request-property-all-of-removed

    • added OrganizationRoleEnum to the default_role response property allOf list for the response status 200

      response-property-all-of-added

    • removed Role9e7Enum from the default_role response property allOf list for the response status 200

      response-property-all-of-removed

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional request property custom_interfaces_enabled (media type: application/json)

      new-optional-request-property

    • added the new optional request property custom_interfaces_enabled (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • added the new optional request property custom_interfaces_enabled (media type: multipart/form-data)

      new-optional-request-property

    • added the new optional request property embed_enabled (media type: application/json)

      new-optional-request-property

    • added the new optional request property embed_enabled (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • added the new optional request property embed_enabled (media type: multipart/form-data)

      new-optional-request-property

    • added the new optional request property interface_settings (media type: application/json)

      new-optional-request-property

    • added the new optional request property interface_settings (media type: application/x-www-form-urlencoded)

      new-optional-request-property

    • added the new optional request property interface_settings (media type: multipart/form-data)

      new-optional-request-property

    • added the optional property custom_interfaces_enabled to the response with the 200 status

      response-optional-property-added

    • added the optional property embed_enabled to the response with the 200 status

      response-optional-property-added

    • added the optional property interface_settings to the response with the 200 status

      response-optional-property-added

Of the 97 revisions, 1 has no diff computed.