✨ Update organization member/role

PATCH

http://localhost:8000/api/organizations/:id/memberships

PATCH

/api/organizations/:id/memberships

$ curl -X PATCH http://localhost:8000/api/organizations/1/memberships \
>      -H "Authorization: Token  <api_key>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

200Updated

1 {
2   "concurrency": {},
3   "contributed_to_projects": [
4     {
5       "id": 1,
6       "title": "string"
7     }
8   ],
9   "created_projects": [
10     {
11       "id": 1,
12       "title": "string"
13     }
14   ],
15   "flex": {},
16   "id": 1,
17   "organization": 1,
18   "role": "OW",
19   "role_source": "manual",
20   "tags": [
21     {
22       "id": 1,
23       "label": "string"
24     }
25   ],
26   "user": {
27     "avatar": "string",
28     "id": 1,
29     "initials": "?",
30     "last_activity": "2024-01-15T09:30:00Z",
31     "lse_fields": {
32       "email_notification_settings": {},
33       "invite_expired": true,
34       "invite_expired_at": "2024-01-15T09:30:00Z",
35       "invite_activated": true,
36       "invited_at": "2024-01-15T09:30:00Z",
37       "invited_by": 1,
38       "onboarding_state": "not_started",
39       "social_auth_finished": true,
40       "trial_company": "string",
41       "trial_experience_labeling": "string",
42       "trial_license_enterprise": true,
43       "trial_models_in_production": "string",
44       "trial_role": "annotator"
45     },
46     "pause": {},
47     "username": "string",
48     "contributed_to_projects": [
49       {
50         "id": 1,
51         "title": "string"
52       }
53     ],
54     "created_projects": [
55       {
56         "id": 1,
57         "title": "string"
58       }
59     ],
60     "active_organization": 1,
61     "allow_newsletters": true,
62     "custom_hotkeys": null,
63     "date_joined": "2024-01-15T09:30:00Z",
64     "email": "string",
65     "first_name": "string",
66     "last_name": "string",
67     "phone": "string"
68   },
69   "user_type": "string"
70 }

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

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.

<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.

Authentication

AuthorizationToken

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:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

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

A unique integer value identifying this organization.

Request

This endpoint expects an object.

roleenumOptional

Organization role

OW - Owner
AD - Administrator
MA - Manager
RE - Reviewer
AN - Annotator
DI - Deactivated
NO - Not Activated

user_idintegerOptional

Member

user_typeenumOptional

Membership seat type. Assigning a working role to a View-Only member upgrades them to a paid Standard seat. View-Only is not accepted because paid-to-View-Only downgrade is not supported.

standard - Standard

Response

concurrencymap from strings to any or nullRead-only

contributed_to_projectslist of objects or nullRead-only

created_projectslist of objects or nullRead-only

flexmap from strings to any or nullRead-only

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

idintegerRead-only

organizationinteger

Organization ID

roleenum

OW - Owner
AD - Administrator
MA - Manager
RE - Reviewer
AN - Annotator
DI - Deactivated
NO - Not Activated
VO - View Only

role_sourceenum or null

manual - Manual
saml - SAML
scim - SCIM
ldap - LDAP
api - API
billing - Billing

tagslist of objectsRead-only

userobject

A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations

user_typestring or nullRead-only