members
Accessed as client.orgs.members; the async client mirrors it.
OrgsMembers
The orgs.members namespace.
delete
delete(org: str, username: str) -> None
Remove a member from an organization.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
org
|
str
|
name of the organization |
required |
username
|
str
|
username of the user |
required |
Returns:
| Type | Description |
|---|---|
None
|
No content. |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
|
Operation ID: orgDeleteMember
get
get(org: str, username: str) -> None
Check if a user is a member of an organization.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
org
|
str
|
name of the organization |
required |
username
|
str
|
username of the user |
required |
Returns:
| Type | Description |
|---|---|
None
|
No content. |
Raises:
| Type | Description |
|---|---|
APIError
|
|
NotFoundError
|
|
Operation ID: orgIsMember
list
List an organization's members.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
org
|
str
|
name of the organization |
required |
page
|
int | None
|
1-based page to start iteration at. |
None
|
limit
|
int | None
|
Page size; the instance caps it server-side. |
None
|
Returns:
| Type | Description |
|---|---|
Paginated[User]
|
UserList. |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
|
Operation ID: orgListMembers
AsyncOrgsMembers
The orgs.members namespace.
delete
delete(org: str, username: str) -> None
Remove a member from an organization.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
org
|
str
|
name of the organization |
required |
username
|
str
|
username of the user |
required |
Returns:
| Type | Description |
|---|---|
None
|
No content. |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
|
Operation ID: orgDeleteMember
get
get(org: str, username: str) -> None
Check if a user is a member of an organization.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
org
|
str
|
name of the organization |
required |
username
|
str
|
username of the user |
required |
Returns:
| Type | Description |
|---|---|
None
|
No content. |
Raises:
| Type | Description |
|---|---|
APIError
|
|
NotFoundError
|
|
Operation ID: orgIsMember
list
list(org: str, *, page: int | None = None, limit: int | None = None) -> AsyncPaginated[User]
List an organization's members.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
org
|
str
|
name of the organization |
required |
page
|
int | None
|
1-based page to start iteration at. |
None
|
limit
|
int | None
|
Page size; the instance caps it server-side. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncPaginated[User]
|
UserList. |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
|
Operation ID: orgListMembers