chitose.com.atproto.admin package#

Submodules#

chitose.com.atproto.admin.defs module#

class chitose.com.atproto.admin.defs.AccountView(did: str, handle: str, indexed_at: str, email: str | None = None, related_records: list[Any] | None = None, invited_by: InviteCode | None = None, invites: list[InviteCode] | None = None, invites_disabled: bool | None = None, email_confirmed_at: str | None = None, invite_note: str | None = None, deactivated_at: str | None = None)#

Bases: Object

to_dict() → dict[str, Any]#
class chitose.com.atproto.admin.defs.RepoBlobRef(did: str, cid: str, record_uri: str | None = None)#

Bases: Object

to_dict() → dict[str, Any]#
class chitose.com.atproto.admin.defs.RepoRef(did: str)#

Bases: Object

to_dict() → dict[str, Any]#
class chitose.com.atproto.admin.defs.StatusAttr(applied: bool, ref: str | None = None)#

Bases: Object

to_dict() → dict[str, Any]#

chitose.com.atproto.admin.delete_account module#

chitose.com.atproto.admin.disable_account_invites module#

chitose.com.atproto.admin.disable_invite_codes module#

chitose.com.atproto.admin.enable_account_invites module#

chitose.com.atproto.admin.get_account_info module#

chitose.com.atproto.admin.get_account_infos module#

chitose.com.atproto.admin.get_invite_codes module#

chitose.com.atproto.admin.get_subject_status module#

chitose.com.atproto.admin.search_accounts module#

chitose.com.atproto.admin.send_email module#

chitose.com.atproto.admin.update_account_email module#

chitose.com.atproto.admin.update_account_handle module#

chitose.com.atproto.admin.update_account_password module#

chitose.com.atproto.admin.update_subject_status module#

Module contents#

class chitose.com.atproto.admin.Admin_(call: Callable[[str, list[tuple[str, str | None | int | list[str]]], bytes | dict[str, Any] | None, dict[str, str]], bytes], subscribe: Callable[[str, list[tuple[str, str | None | int | list[str]]], Callable[[str | bytes], None]], None])#

Bases: object

We recommend calling methods in this class via the chitose.BskyAgent class instead of creating instances of this class directly.

delete_account(did: str) → bytes#

Delete a user account as an administrator.

disable_account_invites(account: str, note: str | None = None) → bytes#

Disable an account from receiving new invite codes, but does not invalidate existing codes.

Parameters:

note – Optional reason for disabled invites.

disable_invite_codes(codes: list[str] | None = None, accounts: list[str] | None = None) → bytes#

Disable some set of codes and/or all codes associated with a set of users.

enable_account_invites(account: str, note: str | None = None) → bytes#

Re-enable an account’s ability to receive invite codes.

Parameters:

note – Optional reason for enabled invites.

get_account_info(did: str) → bytes#

Get details about an account.

get_account_infos(dids: list[str]) → bytes#

Get details about some accounts.

get_invite_codes(sort: Literal['recent', 'usage'] | None = None, limit: int | None = None, cursor: str | None = None) → bytes#

Get an admin view of invite codes.

get_subject_status(did: str | None = None, uri: str | None = None, blob: str | None = None) → bytes#

Get the service-specific admin status of a subject (account, record, or blob).

search_accounts(email: str | None = None, cursor: str | None = None, limit: int | None = None) → bytes#

Get list of accounts that matches your search query.

send_email(recipient_did: str, content: str, sender_did: str, subject: str | None = None, comment: str | None = None) → bytes#

Send email to a user’s account email address.

Parameters:

comment – Additional comment by the sender that won’t be used in the email itself but helpful to provide more context for moderators/reviewers

update_account_email(account: str, email: str) → bytes#

Administrative action to update an account’s email.

Parameters:

account – The handle or DID of the repo.

update_account_handle(did: str, handle: str) → bytes#

Administrative action to update an account’s handle.

update_account_password(did: str, password: str) → bytes#

Update the password for a user account as an administrator.

update_subject_status(subject: RepoRef | StrongRef | RepoBlobRef, takedown: StatusAttr | None = None, deactivated: StatusAttr | None = None) → bytes#

Update the service-specific admin status of a subject (account, record, or blob).

On this page
Show Source