Skip to content

public_members

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

OrgsPublicMembers

The orgs.public_members namespace.

conceal

conceal(org: str, username: str) -> None

Conceal a user's membership.

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
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: orgConcealMember

get

get(org: str, username: str) -> None

Check if a user is a public 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
NotFoundError
  1. user is not a public member.

Operation ID: orgIsPublicMember

list

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

List an organization's public 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
  1. APINotFound is a not found error response.

Operation ID: orgListPublicMembers

publicize

publicize(org: str, username: str) -> None

Publicize a user's membership.

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
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: orgPublicizeMember

AsyncOrgsPublicMembers

The orgs.public_members namespace.

conceal

conceal(org: str, username: str) -> None

Conceal a user's membership.

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
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: orgConcealMember

get

get(org: str, username: str) -> None

Check if a user is a public 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
NotFoundError
  1. user is not a public member.

Operation ID: orgIsPublicMember

list

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

List an organization's public 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
  1. APINotFound is a not found error response.

Operation ID: orgListPublicMembers

publicize

publicize(org: str, username: str) -> None

Publicize a user's membership.

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
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: orgPublicizeMember