]j4 d dl Zd dlZddlmZmZ ddlmZmZ ddl m
Z
ddl m Z ddl
mZ dd lmZmZ G d
d Z G d d
Zy) N )AsyncClientWrapperSyncClientWrapper)
AsyncPager SyncPager)RequestOptions)#PaginatedPaginatedProjectMemberList)PaginatedProjectMember )AsyncRawPaginatedClientRawPaginatedClientc ! e Zd ZdefdZedefd Zdddddddddddddd
dede j e d e j e d
e j e
j d e j e
j d e j e d
e j e de j e de j e de j e de j e de j e de j e de j e deeef f dZy)PaginatedClientclient_wrapperc & t | | _ y N)r )r
_raw_clientselfr s \/root/env/lib/python3.12/site-packages/label_studio_sdk/projects/members/paginated/client.py__init__zPaginatedClient.__init__ s -^L returnc | j S )z
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawPaginatedClient
r r s r with_raw_responsez!PaginatedClient.with_raw_response r N
idsimplicitlast_activity_gtelast_activity_lte
no_annotatorsorderingpage page_sizerolesearchtags with_deletedrequest_optionsidr r! r" r# r$ r% r& r' r( r) r* r+ r, c
T | j j ||||||||| |
| | |
| S )a;
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve the members for a specific project.
**Response Fields:**
- `implicit_member` (boolean): Indicates if the user is an implicit member.
- `true`: User has access via workspace membership or organization role (Administrator/Owner)
- `false`: User is an explicit project member (added directly to the project)
- `project_role` (string|null): Project-specific role override if assigned, null otherwise
**Note:** Users can have both explicit membership AND implicit access. The `implicit_member` field is `false` if the user has an explicit ProjectMember entry, regardless of whether they also have implicit access via workspace or org role.
Parameters
----------
id : int
ids : typing.Optional[str]
Comma-separated list of user IDs to filter by
implicit : typing.Optional[bool]
Include/Exclude implicit project members in the results. If not provided, explicit + implicit members are returned.
last_activity_gte : typing.Optional[dt.datetime]
Filter by last activity time (ISO 8601 datetime). Returns users with last activity greater than or equal to this time.
last_activity_lte : typing.Optional[dt.datetime]
Filter by last activity time (ISO 8601 datetime). Returns users with last activity less than or equal to this time.
no_annotators : typing.Optional[bool]
Exclude annotators from the results
ordering : typing.Optional[str]
Ordering field. Prefix with "-" for descending order. Allowed fields: id, email, first_name, last_name, username, last_activity, role, date_joined
**Note on role ordering:**
When ordering by "role", the system uses the effective role:
- Project-specific role if assigned (takes precedence)
- Organization role if no project role is assigned
Roles are sorted alphabetically by their code: AD (Administrator), AN (Annotator), DI (Disabled), MA (Manager), NO (Not Activated), OW (Owner), RE (Reviewer)
page : typing.Optional[int]
A page number within the paginated result set.
page_size : typing.Optional[int]
Number of results to return per page.
role : typing.Optional[str]
Filter members by role. Accepts single role or comma-separated list of roles.
**Format:**
- Single role: `?role=RE`
- Multiple roles: `?role=AN,RE` (users with ANY of these roles)
**Role Codes:**
- `OW` = Owner
- `AD` = Administrator
- `MA` = Manager
- `RE` = Reviewer
- `AN` = Annotator
**Matching Logic:**
Returns users who have any of the specified roles either:
1. As their **project-specific role** (from project role assignments), OR
2. As their **organization role** (if they have no project-specific role override)
**Note:** Project-specific roles take precedence. If a user has a project role assigned, their organization role is ignored for filtering purposes.
search : typing.Optional[str]
Search term for filtering members by name, email, or username
tags : typing.Optional[str]
Filter members by tags. Use a comma-separated list of tag IDs.
with_deleted : typing.Optional[bool]
Include deleted members in the results
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
SyncPager[PaginatedProjectMember, PaginatedPaginatedProjectMemberList]
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
response = client.projects.members.paginated.list(
id=1,
)
for item in response:
yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
yield page
r r listr r- r r! r" r# r$ r% r& r' r( r) r* r+ r, s r r0 zPaginatedClient.list sM x $$ / /' % + %
r )__name__
__module__ __qualname__r r propertyr
r inttypingOptionalstrbooldtdatetimer r r
r r0 r r r r s M*; M #5 %)*.:>:>/3)-%)*.%)'+%).2;?!K
K
__S
! K
//$' K
"??2;;7
K
"??2;;7K
t,K
//#&K
ooc"K
??3'K
ooc"K
$K
ooc" K
ood+ K
8!K
"
)+NN O#K
r r c ! e Zd ZdefdZedefd Zdddddddddddddd
dede j e d e j e d
e j e
j d e j e
j d e j e d
e j e de j e de j e de j e de j e de j e de j e de j e deeef f dZy)AsyncPaginatedClientr c & t | | _ y r )r r r s r r z AsyncPaginatedClient.__init__ s 2.Qr r c | j S )z
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawPaginatedClient
r r s r r z&AsyncPaginatedClient.with_raw_response r r Nr r- r r! r" r# r$ r% r& r' r( r) r* r+ r, c
p K | j j ||||||||| |
| | |
| d{ S 7 w)a
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve the members for a specific project.
**Response Fields:**
- `implicit_member` (boolean): Indicates if the user is an implicit member.
- `true`: User has access via workspace membership or organization role (Administrator/Owner)
- `false`: User is an explicit project member (added directly to the project)
- `project_role` (string|null): Project-specific role override if assigned, null otherwise
**Note:** Users can have both explicit membership AND implicit access. The `implicit_member` field is `false` if the user has an explicit ProjectMember entry, regardless of whether they also have implicit access via workspace or org role.
Parameters
----------
id : int
ids : typing.Optional[str]
Comma-separated list of user IDs to filter by
implicit : typing.Optional[bool]
Include/Exclude implicit project members in the results. If not provided, explicit + implicit members are returned.
last_activity_gte : typing.Optional[dt.datetime]
Filter by last activity time (ISO 8601 datetime). Returns users with last activity greater than or equal to this time.
last_activity_lte : typing.Optional[dt.datetime]
Filter by last activity time (ISO 8601 datetime). Returns users with last activity less than or equal to this time.
no_annotators : typing.Optional[bool]
Exclude annotators from the results
ordering : typing.Optional[str]
Ordering field. Prefix with "-" for descending order. Allowed fields: id, email, first_name, last_name, username, last_activity, role, date_joined
**Note on role ordering:**
When ordering by "role", the system uses the effective role:
- Project-specific role if assigned (takes precedence)
- Organization role if no project role is assigned
Roles are sorted alphabetically by their code: AD (Administrator), AN (Annotator), DI (Disabled), MA (Manager), NO (Not Activated), OW (Owner), RE (Reviewer)
page : typing.Optional[int]
A page number within the paginated result set.
page_size : typing.Optional[int]
Number of results to return per page.
role : typing.Optional[str]
Filter members by role. Accepts single role or comma-separated list of roles.
**Format:**
- Single role: `?role=RE`
- Multiple roles: `?role=AN,RE` (users with ANY of these roles)
**Role Codes:**
- `OW` = Owner
- `AD` = Administrator
- `MA` = Manager
- `RE` = Reviewer
- `AN` = Annotator
**Matching Logic:**
Returns users who have any of the specified roles either:
1. As their **project-specific role** (from project role assignments), OR
2. As their **organization role** (if they have no project-specific role override)
**Note:** Project-specific roles take precedence. If a user has a project role assigned, their organization role is ignored for filtering purposes.
search : typing.Optional[str]
Search term for filtering members by name, email, or username
tags : typing.Optional[str]
Filter members by tags. Use a comma-separated list of tag IDs.
with_deleted : typing.Optional[bool]
Include deleted members in the results
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncPager[PaginatedProjectMember, PaginatedPaginatedProjectMemberList]
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
response = await client.projects.members.paginated.list(
id=1,
)
async for item in response:
yield item
# alternatively, you can paginate page-by-page
async for page in response.iter_pages():
yield page
asyncio.run(main())
r Nr/ r1 s r r0 zAsyncPaginatedClient.list s[ J %%** / /' % + +
s -646)r2 r3 r4 r r r5 r r r6 r7 r8 r9 r: r; r< r r r
r r0 r= r r r? r? s R*< R #: %)*.:>:>/3)-%)*.%)'+%).2;?!T
T
__S
! T
//$' T
"??2;;7
T
"??2;;7T
t,T
//#&T
ooc"T
??3'T
ooc"T
$T
ooc" T
ood+ T
8!T
"
*,OO P#T
r r? )r< r; r7 core.client_wrapperr r core.paginationr r core.request_optionsr -types.paginated_paginated_project_member_listr types.paginated_project_memberr
raw_clientr r
r r? r= r r rI s8
I 5 3 a E CZ
Z
zc
c
r