orgs

Accessed as client.users.orgs; the async client mirrors it.

SyncAsync

UsersOrgs

The users.orgs namespace.

list(username: str, *, page: int | None = None, limit: int | None = None) -> Paginated[Organization]

List a user's organizations.

Parameters:

Name	Type	Description	Default
`username`	`str`	username of user	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[Organization]`	OrganizationListWithoutPagination - Organizations without pagination headers.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.

Operation ID: orgListUserOrgs

permissions(username: str, org: str) -> OrganizationPermissions

Get user permissions in organization.

Parameters:

Name	Type	Description	Default
`username`	`str`	username of user	required
`org`	`str`	name of the organization	required

Returns:

Type	Description
`OrganizationPermissions`	OrganizationPermissions.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: orgGetUserPermissions

The users.orgs namespace.

list(username: str, *, page: int | None = None, limit: int | None = None) -> AsyncPaginated[Organization]

List a user's organizations.

Parameters:

Name	Type	Description	Default
`username`	`str`	username of user	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[Organization]`	OrganizationListWithoutPagination - Organizations without pagination headers.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.

Operation ID: orgListUserOrgs

permissions(username: str, org: str) -> OrganizationPermissions

Get user permissions in organization.

Parameters:

Name	Type	Description	Default
`username`	`str`	username of user	required
`org`	`str`	name of the organization	required

Returns:

Type	Description
`OrganizationPermissions`	OrganizationPermissions.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: orgGetUserPermissions