Organizations

✨ Update organization member/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 organization membership or role for a specific user ID.

User Rotation Best Practices for API Usage

To maintain compliance with our licensing terms and ensure optimal performance of HumanSignal's APIs, please consider the following guidelines when managing user assignments:

  • Maintain the Minimum Assignment duration: Once a licensed seat is assigned to a user, maintain that assignment for at least the minimum consecutive days before rotating the user. This duration can be found in your enterprise contract language.

  • Automate, Monitor, and Log Rotations: Implement automated scheduling and logging mechanisms to track the timing of user rotations. This helps ensure that rotations adhere to the aforementioned minimum period.

  • Adhere to API Update Frequency and Wait Periods: When updating user assignments via our APIs, follow the recommended frequency and wait period guidelines provided in the HumanSignal API documentation. Avoid sending rapid, successive requests that might overload the endpoint. Instead, incorporate appropriate delays between calls as specified in the documentation.

  • Avoid Overloading the API Endpoint: Design your integration to batch or schedule updates where possible, and implement backoff strategies if the API indicates rate limiting. This helps prevent service disruptions and ensures a smooth operation.

patch/api/organizations/{id}/memberships

Path parameters

idinteger required

A unique integer value identifying this organization.

Request body

role'OW' | 'AD' | 'MA' | 'RE' | 'AN' | 'DI' | 'NO'
  • OW - Owner
  • AD - Administrator
  • MA - Manager
  • RE - Reviewer
  • AN - Annotator
  • DI - Deactivated
  • NO - Not Activated
user_idinteger

Member

user_type'standard'
  • standard - Standard

Response

concurrencyobject nullable required
flexobject nullable required

Per-member Flex claim/window state for Members UI (FIT-2339).

idinteger required
organizationinteger required

Organization ID

role'OW' | 'AD' | 'MA' | 'RE' | 'AN' | 'DI' | 'NO' | 'VO' required
  • OW - Owner
  • AD - Administrator
  • MA - Manager
  • RE - Reviewer
  • AN - Annotator
  • DI - Deactivated
  • NO - Not Activated
  • VO - View Only
role_source'manual' | 'saml' | 'scim' | 'ldap' | 'api' | 'billing' required
  • manual - Manual
  • saml - SAML
  • scim - SCIM
  • ldap - LDAP
  • api - API
  • billing - Billing
user_typestring nullable required

Changes

Changed in 7 of the 97 revisions of this API.1967

  • 1d13f90af57a32See the full diff
    • the response property role_source became nullable for the status 200

      response-property-became-nullable

    • the role response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • the role_source response's property type/format changed from string/ to / for status 200

      response-property-type-changed

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

      response-property-all-of-added

    • added RoleSourceEnum to the role_source response property allOf list for the response status 200

      response-property-all-of-added

    • added the required property flex to the response with the 200 status

      response-required-property-added

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

      new-optional-request-property

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

      new-optional-request-property

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

      new-optional-request-property

  • d61bc77f80bc33See the full diff
    • added AssignableOrganizationRoleEnum to the role request property allOf list (media type: application/json)

      request-property-all-of-added

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

      request-property-all-of-added

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

      request-property-all-of-added

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

      request-property-all-of-removed

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

      request-property-all-of-removed

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

      request-property-all-of-removed

    • the response property concurrency became nullable for the status 200

      response-property-became-nullable

    • the response property user/avatar became nullable for the status 200

      response-property-became-nullable

    • the response property user/lse_fields/allOf[LseFields]/invite_expired became nullable for the status 200

      response-property-became-nullable

    • the response property user/lse_fields/allOf[LseFields]/invite_expired_at became nullable for the status 200

      response-property-became-nullable

    • the response property user/pause became nullable for the status 200

      response-property-became-nullable

    • the response property user_type became nullable for the status 200

      response-property-became-nullable

    • the concurrency response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

    • the user/lse_fields/allOf[LseFields]/email_notification_settings response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

    • the user/lse_fields/allOf[LseFields]/invite_expired response's property type/format changed from string/ to boolean/ for status 200

      response-property-type-changed

    • the user/pause response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

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

      request-property-all-of-added

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

      request-property-all-of-added

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

      request-property-all-of-added

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

      request-property-all-of-removed

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

      request-property-all-of-removed

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

      request-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 required property user_type to the response with the 200 status

      response-required-property-added

Of the 97 revisions, 1 has no diff computed.