com_atproto_services
library
Functions
-
comAtprotoAdminDeleteAccount({required String did, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Delete a user account as an administrator.
-
comAtprotoAdminDisableAccountInvites({required String account, String? note, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Disable an account from receiving new invite codes, but does not invalidate existing codes.
-
comAtprotoAdminDisableInviteCodes({List<String>? codes, List<String>? accounts, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Disable some set of codes and/or all codes associated with a set of users.
-
comAtprotoAdminEnableAccountInvites({required String account, String? note, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Re-enable an account's ability to receive invite codes.
-
comAtprotoAdminGetAccountInfo({required String did, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<AccountView>>
-
Get details about an account.
-
comAtprotoAdminGetAccountInfos({required List<String> dids, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<AdminGetAccountInfosOutput>>
-
Get details about some accounts.
-
comAtprotoAdminGetInviteCodes({AdminGetInviteCodesSort? sort, int? limit, String? cursor, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<AdminGetInviteCodesOutput>>
-
Get an admin view of invite codes.
-
comAtprotoAdminGetSubjectStatus({String? did, AtUri? uri, String? blob, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<AdminGetSubjectStatusOutput>>
-
Get the service-specific admin status of a subject (account, record, or blob).
-
comAtprotoAdminSearchAccounts({String? email, String? cursor, int? limit, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<AdminSearchAccountsOutput>>
-
Get list of accounts that matches your search query.
-
comAtprotoAdminSendEmail({required String recipientDid, required String content, String? subject, required String senderDid, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<AdminSendEmailOutput>>
-
Send email to a user's account email address.
-
comAtprotoAdminUpdateAccountEmail({required String account, required String email, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Administrative action to update an account's email.
-
comAtprotoAdminUpdateAccountHandle({required String did, required String handle, required ServiceContext $ctx, Map<String, String>? $headers, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Administrative action to update an account's handle.
-
comAtprotoAdminUpdateAccountPassword({required String did, required String password, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Update the password for a user account as an administrator.
-
comAtprotoAdminUpdateAccountSigningKey({required String did, required String signingKey, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Administrative action to update an account's signing key in their Did document.
-
comAtprotoAdminUpdateSubjectStatus({required UAdminUpdateSubjectStatusSubject subject, StatusAttr? takedown, StatusAttr? deactivated, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<AdminUpdateSubjectStatusOutput>>
-
Update the service-specific admin status of a subject (account, record, or blob).
-
comAtprotoIdentityGetRecommendedDidCredentials({required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<IdentityGetRecommendedDidCredentialsOutput>>
-
Describe the credentials that should be included in the DID doc of an account that is migrating to this service.
-
comAtprotoIdentityRefreshIdentity({required String identifier, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<IdentityInfo>>
-
Request that the server re-resolve an identity (DID and handle). The server may ignore this request, or require authentication, depending on the role, implementation, and policy of the server.
-
comAtprotoIdentityRequestPlcOperationSignature({required ServiceContext $ctx, })
→ Future<XRPCResponse<EmptyData>>
-
Request an email with a code to in order to request a signed PLC operation. Requires Auth.
-
comAtprotoIdentityResolveDid({required String did, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<IdentityResolveDidOutput>>
-
Resolves DID to DID document. Does not bi-directionally verify handle.
-
comAtprotoIdentityResolveHandle({required String handle, required ServiceContext $ctx, Map<String, String>? $headers, Map<String, String>? $unknown})
→ Future<XRPCResponse<IdentityResolveHandleOutput>>
-
Resolves an atproto handle (hostname) to a DID. Does not necessarily bi-directionally verify against the the DID document.
-
comAtprotoIdentityResolveIdentity({required String identifier, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<IdentityInfo>>
-
Resolves an identity (DID or Handle) to a full identity (DID document and verified handle).
-
comAtprotoIdentitySignPlcOperation({String? token, List<String>? rotationKeys, List<String>? alsoKnownAs, Map<String, dynamic>? verificationMethods, Map<String, dynamic>? services, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<IdentitySignPlcOperationOutput>>
-
Signs a PLC operation to update some value(s) in the requesting DID's document.
-
comAtprotoIdentitySubmitPlcOperation({required Map<String, dynamic> operation, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Validates a PLC operation to ensure that it doesn't violate a service's constraints or get the identity into a bad state, then submits it to the PLC registry
-
comAtprotoIdentityUpdateHandle({required String handle, required ServiceContext $ctx, Map<String, String>? $headers, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Updates the current account's handle. Verifies handle validity, and updates did:plc document if necessary. Implemented by PDS, and requires auth.
-
comAtprotoLabelQueryLabels({required List<String> uriPatterns, List<String>? sources, int? limit, String? cursor, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<LabelQueryLabelsOutput>>
-
Find labels relevant to the provided AT-URI patterns. Public endpoint for moderation services, though may return different or additional results with auth.
-
comAtprotoLabelSubscribeLabels({int? cursor, required ServiceContext $ctx})
→ Future<XRPCResponse<Subscription<Uint8List>>>
-
Subscribe to stream of labels (and negations). Public endpoint implemented by mod services. Uses same sequencing scheme as repo event stream.
-
comAtprotoModerationCreateReport({required ReasonType reasonType, String? reason, required UModerationCreateReportSubject subject, ModTool? modTool, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<ModerationCreateReportOutput>>
-
Submit a moderation report regarding an atproto account or record. Implemented by moderation services (with PDS proxying), and requires auth.
-
comAtprotoRepoApplyWrites({required String repo, bool? validate, required List<URepoApplyWritesWrites> writes, String? swapCommit, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<RepoApplyWritesOutput>>
-
Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS.
-
comAtprotoRepoCreateRecord({required String repo, required String collection, String? rkey, bool? validate, required Map<String, dynamic> record, String? swapCommit, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<RepoCreateRecordOutput>>
-
Create a single new repository record. Requires auth, implemented by PDS.
-
comAtprotoRepoDeleteRecord({required String repo, required String collection, required String rkey, String? swapRecord, String? swapCommit, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<RepoDeleteRecordOutput>>
-
Delete a repository record, or ensure it doesn't exist. Requires auth, implemented by PDS.
-
comAtprotoRepoDescribeRepo({required String repo, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<RepoDescribeRepoOutput>>
-
Get information about an account and repository, including the list of collections. Does not require auth.
-
comAtprotoRepoGetRecord({required String repo, required String collection, required String rkey, String? cid, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<RepoGetRecordOutput>>
-
Get a single record from a repository. Does not require auth.
-
comAtprotoRepoImportRepo({required Uint8List bytes, required ServiceContext $ctx, Map<String, String>? $parameters})
→ Future<XRPCResponse<EmptyData>>
-
Import a repo in the form of a CAR file. Requires Content-Length HTTP header to be set.
-
comAtprotoRepoListMissingBlobs({int? limit, String? cursor, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<RepoListMissingBlobsOutput>>
-
Returns a list of missing blobs for the requesting account. Intended to be used in the account migration flow.
-
comAtprotoRepoListRecords({required String repo, required String collection, int? limit, String? cursor, bool? reverse, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<RepoListRecordsOutput>>
-
List a range of records in a repository, matching a specific collection. Does not require auth.
-
comAtprotoRepoPutRecord({required String repo, required String collection, required String rkey, bool? validate, required Map<String, dynamic> record, String? swapRecord, String? swapCommit, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<RepoPutRecordOutput>>
-
Write a repository record, creating or updating it as needed. Requires auth, implemented by PDS.
-
comAtprotoRepoUploadBlob({required Uint8List bytes, required ServiceContext $ctx, Map<String, String>? $parameters})
→ Future<XRPCResponse<RepoUploadBlobOutput>>
-
Upload a new blob, to be referenced from a repository record. The blob will be deleted if it is not referenced within a time window (eg, minutes). Blob restrictions (mimetype, size, etc) are enforced when the reference is created. Requires auth, implemented by PDS.
-
comAtprotoServerActivateAccount({required ServiceContext $ctx, })
→ Future<XRPCResponse<EmptyData>>
-
Activates a currently deactivated account. Used to finalize account migration after the account's repo is imported and identity is setup.
-
comAtprotoServerCheckAccountStatus({required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<ServerCheckAccountStatusOutput>>
-
Returns the status of an account, especially as pertaining to import or recovery. Can be called many times over the course of an account migration. Requires auth and can only be called pertaining to oneself.
-
comAtprotoServerConfirmEmail({required String email, required String token, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Confirm an email using a token from com.atproto.server.requestEmailConfirmation.
-
comAtprotoServerCreateAccount({String? email, required String handle, String? did, String? inviteCode, String? verificationCode, String? verificationPhone, String? password, String? recoveryKey, Map<String, dynamic>? plcOp, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<ServerCreateAccountOutput>>
-
Create an account. Implemented by PDS.
-
comAtprotoServerCreateAppPassword({required String name, bool? privileged, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<AppPassword>>
-
Create an App Password.
-
comAtprotoServerCreateInviteCode({required int useCount, String? forAccount, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<ServerCreateInviteCodeOutput>>
-
Create an invite code.
-
comAtprotoServerCreateInviteCodes({required int codeCount, required int useCount, List<String>? forAccounts, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<ServerCreateInviteCodesOutput>>
-
Create invite codes.
-
comAtprotoServerCreateSession({required String identifier, required String password, String? authFactorToken, bool? allowTakendown, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<ServerCreateSessionOutput>>
-
Create an authentication session.
-
comAtprotoServerDeactivateAccount({DateTime? deleteAfter, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Deactivates a currently active account. Stops serving of repo, and future writes to repo until reactivated. Used to finalize account migration with the old host after the account has been activated on the new host.
-
comAtprotoServerDeleteAccount({required String did, required String password, required String token, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Delete an actor's account with a token and password. Can only be called after requesting a deletion token. Requires auth.
-
comAtprotoServerDeleteSession({required ServiceContext $ctx, })
→ Future<XRPCResponse<EmptyData>>
-
Delete the current session. Requires auth.
-
comAtprotoServerDescribeServer({required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<ServerDescribeServerOutput>>
-
Describes the server's account creation requirements and capabilities. Implemented by PDS.
-
comAtprotoServerGetAccountInviteCodes({bool? includeUsed, bool? createAvailable, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<ServerGetAccountInviteCodesOutput>>
-
Get all invite codes for the current account. Requires auth.
-
comAtprotoServerGetServiceAuth({required String aud, int? exp, String? lxm, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<ServerGetServiceAuthOutput>>
-
Get a signed token on behalf of the requesting DID for the requested service.
-
comAtprotoServerGetSession({required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<ServerGetSessionOutput>>
-
Get information about the current auth session. Requires auth.
-
comAtprotoServerListAppPasswords({required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<ServerListAppPasswordsOutput>>
-
List all App Passwords.
-
comAtprotoServerRefreshSession({required ServiceContext $ctx, })
→ Future<XRPCResponse<ServerRefreshSessionOutput>>
-
Refresh an authentication session. Requires auth using the 'refreshJwt' (not the 'accessJwt').
-
comAtprotoServerRequestAccountDelete({required ServiceContext $ctx, })
→ Future<XRPCResponse<EmptyData>>
-
Initiate a user account deletion via email.
-
comAtprotoServerRequestEmailConfirmation({required ServiceContext $ctx, })
→ Future<XRPCResponse<EmptyData>>
-
Request an email with a code to confirm ownership of email.
-
comAtprotoServerRequestEmailUpdate({required ServiceContext $ctx, })
→ Future<XRPCResponse<ServerRequestEmailUpdateOutput>>
-
Request a token in order to update email.
-
comAtprotoServerRequestPasswordReset({required String email, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Initiate a user account password reset via email.
-
comAtprotoServerReserveSigningKey({String? did, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<ServerReserveSigningKeyOutput>>
-
Reserve a repo signing key, for use with account creation. Necessary so that a DID PLC update operation can be constructed during an account migraiton. Public and does not require auth; implemented by PDS. NOTE: this endpoint may change when full account migration is implemented.
-
comAtprotoServerResetPassword({required String token, required String password, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Reset a user account password using a token.
-
comAtprotoServerRevokeAppPassword({required String name, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Revoke an App Password by name.
-
comAtprotoServerUpdateEmail({required String email, bool? emailAuthFactor, String? token, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Update an account's email.
-
comAtprotoSyncGetBlob({required String did, required String cid, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<Uint8List>>
-
Get a blob associated with a given account. Returns the full blob as originally uploaded. Does not require auth; implemented by PDS.
-
comAtprotoSyncGetBlocks({required String did, required List<String> cids, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<Uint8List>>
-
Get data blocks from a given repo, by CID. For example, intermediate MST nodes, or records. Does not require auth; implemented by PDS.
-
comAtprotoSyncGetCheckout({required String did, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<Uint8List>>
-
DEPRECATED - please use com.atproto.sync.getRepo instead
-
comAtprotoSyncGetHead({required String did, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<SyncGetHeadOutput>>
-
DEPRECATED - please use com.atproto.sync.getLatestCommit instead
-
comAtprotoSyncGetHostStatus({required String hostname, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<SyncGetHostStatusOutput>>
-
Returns information about a specified upstream host, as consumed by the server. Implemented by relays.
-
comAtprotoSyncGetLatestCommit({required String did, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<SyncGetLatestCommitOutput>>
-
Get the current commit CID & revision of the specified repo. Does not require auth.
-
comAtprotoSyncGetRecord({required String did, required String collection, required String rkey, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<Uint8List>>
-
Get data blocks needed to prove the existence or non-existence of record in the current version of repo. Does not require auth.
-
comAtprotoSyncGetRepo({required String did, String? since, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<Uint8List>>
-
Download a repository export as CAR file. Optionally only a 'diff' since a previous revision. Does not require auth; implemented by PDS.
-
comAtprotoSyncGetRepoStatus({required String did, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<SyncGetRepoStatusOutput>>
-
Get the hosting status for a repository, on this server. Expected to be implemented by PDS and Relay.
-
comAtprotoSyncListBlobs({required String did, String? since, int? limit, String? cursor, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<SyncListBlobsOutput>>
-
List blob CIDs for an account, since some repo revision. Does not require auth; implemented by PDS.
-
comAtprotoSyncListHosts({int? limit, String? cursor, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<SyncListHostsOutput>>
-
Enumerates upstream hosts (eg, PDS or relay instances) that this service consumes from. Implemented by relays.
-
comAtprotoSyncListRepos({int? limit, String? cursor, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<SyncListReposOutput>>
-
Enumerates all the DID, rev, and commit CID for all repos hosted by this service. Does not require auth; implemented by PDS and Relay.
-
comAtprotoSyncListReposByCollection({required String collection, int? limit, String? cursor, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<SyncListReposByCollectionOutput>>
-
Enumerates all the DIDs which have records with the given collection NSID.
-
comAtprotoSyncNotifyOfUpdate({required String hostname, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Notify a crawling service of a recent update, and that crawling should resume. Intended use is after a gap between repo stream events caused the crawling service to disconnect. Does not require auth; implemented by Relay. DEPRECATED: just use com.atproto.sync.requestCrawl
-
comAtprotoSyncRequestCrawl({required String hostname, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Request a service to persistently crawl hosted repos. Expected use is new PDS instances declaring their existence to Relays. Does not require auth.
-
comAtprotoSyncSubscribeRepos({int? cursor, required ServiceContext $ctx})
→ Future<XRPCResponse<Subscription<Uint8List>>>
-
Repository event stream, aka Firehose endpoint. Outputs repo commits with diff data, and identity update events, for all repositories on the current server. See the atproto specifications for details around stream sequencing, repo versioning, CAR diff format, and more. Public and does not require auth; implemented by PDS and Relay.
-
comAtprotoTempAddReservedHandle({required String handle, required ServiceContext $ctx, Map<String, String>? $headers, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Add a handle to the set of reserved handles.
-
comAtprotoTempCheckHandleAvailability({required String handle, String? email, DateTime? birthDate, required ServiceContext $ctx, Map<String, String>? $headers, Map<String, String>? $unknown})
→ Future<XRPCResponse<TempCheckHandleAvailabilityOutput>>
-
Checks whether the provided handle is available. If the handle is not available, available suggestions will be returned. Optional inputs will be used to generate suggestions.
-
comAtprotoTempCheckSignupQueue({required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<TempCheckSignupQueueOutput>>
-
Check accounts location in signup queue.
-
comAtprotoTempDereferenceScope({required String scope, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<TempDereferenceScopeOutput>>
-
Allows finding the oauth permission scope from a reference
-
comAtprotoTempFetchLabels({int? since, int? limit, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<TempFetchLabelsOutput>>
-
DEPRECATED: use queryLabels or subscribeLabels instead -- Fetch all labels from a labeler created after a certain date.
-
comAtprotoTempRequestPhoneVerification({required String phoneNumber, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Request a verification code to be sent to the supplied phone number
-
comAtprotoTempRevokeAccountCredentials({required String account, required ServiceContext $ctx, Map<String, String>? $unknown})
→ Future<XRPCResponse<EmptyData>>
-
Revoke sessions, password, and app passwords associated with account. May be resolved by a password reset.
