scope

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 29, 2024 License: AGPL-3.0 Imports: 0 Imported by: 1

Documentation

Overview

Package scope contains scope definitions for every Mastodon API route.

Index

Constants

View Source
const AdminRead = "admin:read"

https://docs.joinmastodon.org/api/oauth-scopes/#admin

View Source
const AdminReadAccounts = "admin:read:accounts"
View Source
const AdminReadCanonicalEmailBlocks = "admin:read:canonical_email_blocks"
View Source
const AdminReadDomainAllows = "admin:read:domain_allows"
View Source
const AdminReadDomainBlocks = "admin:read:domain_blocks"
View Source
const AdminReadEmailDomainBlocks = "admin:read:email_domain_blocks"
View Source
const AdminReadIPBlocks = "admin:read:ip_blocks"
View Source
const AdminReadReports = "admin:read:reports"
View Source
const AdminWrite = "admin:write"
View Source
const AdminWriteAccounts = "admin:write:accounts"
View Source
const AdminWriteCanonicalEmailBlocks = "admin:write:canonical_email_blocks"
View Source
const AdminWriteDomainAllows = "admin:write:domain_allows"
View Source
const AdminWriteDomainBlocks = "admin:write:domain_blocks"
View Source
const AdminWriteEmailDomainBlocks = "admin:write:email_domain_blocks"
View Source
const AdminWriteIPBlocks = "admin:write:ip_blocks"
View Source
const AdminWriteReports = "admin:write:reports"
View Source
const DeleteAnnouncement_Reaction = "write:favourites"

https://docs.joinmastodon.org/methods/announcements/#delete-reactions

View Source
const DeleteConversation = WriteConversations

https://docs.joinmastodon.org/methods/conversations/#delete

View Source
const DeleteDomainBlock = WriteBlocks

https://docs.joinmastodon.org/methods/domain_blocks/#unblock

View Source
const DeleteFeaturedTag = WriteAccounts

https://docs.joinmastodon.org/methods/featured_tags/#unfeature

View Source
const DeleteFilter = WriteFilters

https://docs.joinmastodon.org/methods/filters/#delete

View Source
const DeleteFilter_Keyword = WriteFilters

https://docs.joinmastodon.org/methods/filters/#keywords-delete

View Source
const DeleteFilter_Status = WriteFilters

https://docs.joinmastodon.org/methods/filters/#statuses-remove

View Source
const DeleteFilter_V1 = WriteFilters

https://docs.joinmastodon.org/methods/filters/#delete-v1

View Source
const DeleteList = WriteLists

https://docs.joinmastodon.org/methods/lists/#delete

View Source
const DeleteList_Accounts = WriteLists

https://docs.joinmastodon.org/methods/lists/#accounts-remove

View Source
const DeleteProfile_Avatar = WriteAccounts

https://docs.joinmastodon.org/methods/profile/#delete-profile-avatar

View Source
const DeleteProfile_Header = WriteAccounts

https://docs.joinmastodon.org/methods/profile/#delete-profile-header

View Source
const DeleteScheduledStatus = WriteStatuses

https://docs.joinmastodon.org/methods/scheduled_statuses/#cancel

View Source
const DeleteStatus = WriteStatuses

https://docs.joinmastodon.org/methods/statuses/#delete

View Source
const DeleteSuggestion = Read

https://docs.joinmastodon.org/methods/suggestions/#remove

View Source
const GetAccount = Public

https://docs.joinmastodon.org/methods/accounts/#get

View Source
const GetAccount_FamiliarFollowers = ReadFollows

https://docs.joinmastodon.org/methods/accounts/#familiar_followers

View Source
const GetAccount_FeaturedTags = Private

https://docs.joinmastodon.org/methods/accounts/#featured_tags

View Source
const GetAccount_Followers = Private

https://docs.joinmastodon.org/methods/accounts/#followers

View Source
const GetAccount_Following = Private

https://docs.joinmastodon.org/methods/accounts/#following

View Source
const GetAccount_Lists = ReadLists

https://docs.joinmastodon.org/methods/accounts/#lists

View Source
const GetAccount_Lookup = Private

https://docs.joinmastodon.org/methods/accounts/#lookup

View Source
const GetAccount_Search = ReadAccounts

https://docs.joinmastodon.org/methods/accounts/#search

View Source
const GetAccount_Statuses = ReadStatuses

https://docs.joinmastodon.org/methods/accounts/#statuses

View Source
const GetAccount_VerifyCredentials = ReadAccounts

https://docs.joinmastodon.org/methods/accounts/#verify_credentials

View Source
const GetAnnouncements = "*"

https://docs.joinmastodon.org/methods/announcements/#get

View Source
const GetApplication_VerifyCredentials = Private

https://docs.joinmastodon.org/methods/apps/#verify_credentials

View Source
const GetBlocks = ReadBlocks

https://docs.joinmastodon.org/methods/blocks/#get

View Source
const GetBookmarks = ReadBookmarks

https://docs.joinmastodon.org/methods/bookmarks/#get

View Source
const GetConversations = ReadStatuses

https://docs.joinmastodon.org/methods/conversations/#get

View Source
const GetCustomEmojis = Public

https://docs.joinmastodon.org/methods/custom_emojis/#get

View Source
const GetDirectory = Public

https://docs.joinmastodon.org/methods/directory/#get

View Source
const GetDomainBlocks = ReadBlocks

https://docs.joinmastodon.org/methods/domain_blocks/#get

View Source
const GetEndorsements = ReadAccounts

https://docs.joinmastodon.org/methods/endorsements/#get

View Source
const GetFavourites = ReadFavourites

https://docs.joinmastodon.org/methods/favourites/#get

View Source
const GetFeaturedTags = ReadAccounts

https://docs.joinmastodon.org/methods/featured_tags/#get

View Source
const GetFeaturedTags_Suggestions = ReadAccounts

https://docs.joinmastodon.org/methods/featured_tags/#suggestions

View Source
const GetFilter = ReadFilters

https://docs.joinmastodon.org/methods/filters/#get-one

View Source
const GetFilter_Keyword = ReadFilters

https://docs.joinmastodon.org/methods/filters/#keywords-get-one

View Source
const GetFilter_Keywords = ReadFilters

https://docs.joinmastodon.org/methods/filters/#keywords-get

View Source
const GetFilter_Status = ReadFilters

https://docs.joinmastodon.org/methods/filters/#statuses-get-one

View Source
const GetFilter_Statuses = ReadFilters

https://docs.joinmastodon.org/methods/filters/#statuses-get

View Source
const GetFilter_V1 = ReadFilters

https://docs.joinmastodon.org/methods/filters/#get-one-v1

View Source
const GetFilters = ReadFilters

https://docs.joinmastodon.org/methods/filters/#get

View Source
const GetFilters_V1 = ReadFilters

https://docs.joinmastodon.org/methods/filters/#get-v1

View Source
const GetFollowRequests = ReadFollows

https://docs.joinmastodon.org/methods/follow_requests/#get

View Source
const GetFollowedTags = ReadFollows

https://docs.joinmastodon.org/methods/followed_tags/#get

View Source
const GetInstance = Public

https://docs.joinmastodon.org/methods/instance/#v2

View Source
const GetInstance_Activity = Public

https://docs.joinmastodon.org/methods/instance/#activity

View Source
const GetInstance_DomainBlocks = Public

https://docs.joinmastodon.org/methods/instance/#domain_blocks

View Source
const GetInstance_ExtendedDescription = Public

https://docs.joinmastodon.org/methods/instance/#extended_description

View Source
const GetInstance_Peers = Public

https://docs.joinmastodon.org/methods/instance/#peers

View Source
const GetInstance_Rules = Public

https://docs.joinmastodon.org/methods/instance/#rules

View Source
const GetInstance_V1 = Public

https://docs.joinmastodon.org/methods/instance/#v1

View Source
const GetList = WriteLists

https://docs.joinmastodon.org/methods/lists/#get-one

View Source
const GetList_Accounts = ReadLists

https://docs.joinmastodon.org/methods/lists/#accounts

View Source
const GetLists = ReadLists

https://docs.joinmastodon.org/methods/lists/#get

View Source
const GetMarkers = ReadStatuses

https://docs.joinmastodon.org/methods/markers/#get

View Source
const GetMutes = ReadMutes

https://docs.joinmastodon.org/methods/mutes/#get

View Source
const GetNotification = ReadNotifications

https://docs.joinmastodon.org/methods/notifications/#get-one

View Source
const GetNotifications = ReadNotifications

https://docs.joinmastodon.org/methods/notifications/#get

View Source
const GetOAuth_Authorize = Public

https://docs.joinmastodon.org/methods/oauth/#authorize

View Source
const GetOEmbed = Public

https://docs.joinmastodon.org/methods/oembed/#get

View Source
const GetPoll = ReadStatuses

https://docs.joinmastodon.org/methods/polls/#get

View Source
const GetPreferences = ReadAccounts

https://docs.joinmastodon.org/methods/preferences/#get

View Source
const GetScheduledStatus = ReadStatuses

https://docs.joinmastodon.org/methods/scheduled_statuses/#get-one

View Source
const GetScheduledStatuses = ReadStatuses

https://docs.joinmastodon.org/methods/scheduled_statuses/#get

View Source
const GetSearch = ReadSearch

https://docs.joinmastodon.org/methods/search/#v2

View Source
const GetStatus = ReadStatuses

https://docs.joinmastodon.org/methods/statuses/#get

View Source
const GetStatus_Context = ReadStatuses

https://docs.joinmastodon.org/methods/statuses/#context

View Source
const GetStatus_FavouritedBy = ReadStatuses

https://docs.joinmastodon.org/methods/statuses/#favourited_by

View Source
const GetStatus_History = ReadStatuses

https://docs.joinmastodon.org/methods/statuses/#history

View Source
const GetStatus_RebloggedBy = ReadStatuses

https://docs.joinmastodon.org/methods/statuses/#reblogged_by

View Source
const GetStatus_Source = ReadStatuses

https://docs.joinmastodon.org/methods/statuses/#source

View Source
const GetSuggestions = Read

https://docs.joinmastodon.org/methods/suggestions/#v2

View Source
const GetTag = Public

https://docs.joinmastodon.org/methods/tags/#get

View Source
const GetTimeline_Hashtag = ReadStatuses

https://docs.joinmastodon.org/methods/timelines/#tag

View Source
const GetTimeline_Home = ReadStatuses

https://docs.joinmastodon.org/methods/timelines/#home

View Source
const GetTimeline_List = ReadStatuses

https://docs.joinmastodon.org/methods/timelines/#list

View Source
const GetTimeline_Public = ReadStatuses

https://docs.joinmastodon.org/methods/timelines/#public

View Source
const GetTrends = Public

https://docs.joinmastodon.org/methods/trends/#tags

View Source
const GetTrends_Links = Public

https://docs.joinmastodon.org/methods/trends/#links

View Source
const GetTrends_Statuses = Public

https://docs.joinmastodon.org/methods/trends/#statuses

View Source
const PatchAccount_UpdateCredentials = WriteAccounts

https://docs.joinmastodon.org/methods/accounts/#update_credentials

View Source
const PostAccont_Follow = WriteFollows

https://docs.joinmastodon.org/methods/accounts/#follow

View Source
const PostAccount = WriteAccounts

https://docs.joinmastodon.org/methods/accounts/#create

View Source
const PostAccount_Block = WriteBlocks

https://docs.joinmastodon.org/methods/accounts/#block

View Source
const PostAccount_Mute = WriteMutes

https://docs.joinmastodon.org/methods/accounts/#mute

View Source
const PostAccount_Note = WriteAccounts

https://docs.joinmastodon.org/methods/accounts/#note

View Source
const PostAccount_Pin = WriteAccounts

https://docs.joinmastodon.org/methods/accounts/#pin

View Source
const PostAccount_Relationships = ReadFollows

https://docs.joinmastodon.org/methods/accounts/#relationships

View Source
const PostAccount_RemoveFromFollowers = WriteFollows

https://docs.joinmastodon.org/methods/accounts/#remove_from_followers

View Source
const PostAccount_Unblock = WriteBlocks

https://docs.joinmastodon.org/methods/accounts/#unblock

View Source
const PostAccount_Unfollow = WriteFollows

https://docs.joinmastodon.org/methods/accounts/#unfollow

View Source
const PostAccount_Unmute = WriteMutes

https://docs.joinmastodon.org/methods/accounts/#unmute

View Source
const PostAccount_Unpin = WriteAccounts

https://docs.joinmastodon.org/methods/accounts/#unpin

View Source
const PostAnnoucement_Dismis = "write:accounts"

https://docs.joinmastodon.org/methods/announcements/#dismiss

View Source
const PostApplication = ""

https://docs.joinmastodon.org/methods/apps/#create

View Source
const PostConversationRead = WriteConversations

https://docs.joinmastodon.org/methods/conversations/#read

View Source
const PostDomainBlock = WriteBlocks

https://docs.joinmastodon.org/methods/domain_blocks/#block

View Source
const PostEmailConfirmation = Private

https://docs.joinmastodon.org/methods/emails/#confirmation

View Source
const PostFeaturedTag = WriteAccounts

https://docs.joinmastodon.org/methods/featured_tags/#feature

View Source
const PostFilter = WriteFilters

https://docs.joinmastodon.org/methods/filters/#create

View Source
const PostFilter_Keyword = WriteFilters

https://docs.joinmastodon.org/methods/filters/#keywords-create

View Source
const PostFilter_Status = WriteFilters

https://docs.joinmastodon.org/methods/filters/#statuses-add

View Source
const PostFilter_V1 = WriteFilters

https://docs.joinmastodon.org/methods/filters/#create-v1

View Source
const PostFollowRequest_Authorize = WriteFollows

https://docs.joinmastodon.org/methods/follow_requests/#accept

View Source
const PostFollowRequest_Reject = WriteFollows

https://docs.joinmastodon.org/methods/follow_requests/#reject

View Source
const PostList = WriteLists

https://docs.joinmastodon.org/methods/lists/#create

View Source
const PostList_Accounts = WriteLists

https://docs.joinmastodon.org/methods/lists/#accounts-add

View Source
const PostMarker = WriteStatuses

https://docs.joinmastodon.org/methods/markers/#create

View Source
const PostMedia = WriteMedia

https://docs.joinmastodon.org/methods/media/#v2

View Source
const PostNotification_Dismiss = WriteNotifications

https://docs.joinmastodon.org/methods/notifications/#dismiss

View Source
const PostNotifications_Clear = WriteNotifications

https://docs.joinmastodon.org/methods/notifications/#clear

View Source
const PostOAuth_Revoke = Public

https://docs.joinmastodon.org/methods/oauth/#revoke

View Source
const PostOAuth_Token = Public

https://docs.joinmastodon.org/methods/oauth/#token

View Source
const PostPoll_Votes = WriteStatuses

https://docs.joinmastodon.org/methods/polls/#vote

View Source
const PostReport = WriteReports

https://docs.joinmastodon.org/methods/reports/#post

View Source
const PostStatus = WriteStatuses

https://docs.joinmastodon.org/methods/statuses/#create

View Source
const PostStatus_Bookmark = WriteStatuses

https://docs.joinmastodon.org/methods/statuses/#bookmark

View Source
const PostStatus_Favourite = WriteStatuses

https://docs.joinmastodon.org/methods/statuses/#favourite

View Source
const PostStatus_Mute = WriteStatuses

https://docs.joinmastodon.org/methods/statuses/#mute

View Source
const PostStatus_Pin = WriteStatuses

https://docs.joinmastodon.org/methods/statuses/#pin

View Source
const PostStatus_Reblog = WriteStatuses

https://docs.joinmastodon.org/methods/statuses/#reblog

View Source
const PostStatus_Translate = WriteStatuses

https://docs.joinmastodon.org/methods/statuses/#translate

View Source
const PostStatus_Unbookmark = WriteStatuses

https://docs.joinmastodon.org/methods/statuses/#unbookmark

View Source
const PostStatus_Unfavourite = WriteStatuses

https://docs.joinmastodon.org/methods/statuses/#unfavourite

View Source
const PostStatus_Unmute = WriteStatuses

https://docs.joinmastodon.org/methods/statuses/#unmute

View Source
const PostStatus_Unpin = WriteStatuses

https://docs.joinmastodon.org/methods/statuses/#unpin

View Source
const PostStatus_Unreblog = WriteStatuses

https://docs.joinmastodon.org/methods/statuses/#unreblog

View Source
const PostTag_Follow = WriteFollows

https://docs.joinmastodon.org/methods/tags/#follow

View Source
const PostTag_Unfollow = WriteFollows

https://docs.joinmastodon.org/methods/tags/#unfollow

View Source
const Private = "*"

Private is not defined by the Mastodon API, but is used by this library to indicate a private route that requires an App token, but does not require any specific scope.

View Source
const Public = ""

Public is not defined by the Mastodon API, but is used by this library to indicate a public route that does not require an App token.

View Source
const Push = "push"

https://docs.joinmastodon.org/api/oauth-scopes/#push

View Source
const PutAnnouncement_Reaction = "write:favourites"

https://docs.joinmastodon.org/methods/announcements/#put-reactions

View Source
const PutFilter = WriteFilters

https://docs.joinmastodon.org/methods/filters/#update

View Source
const PutFilter_Keyword = WriteFilters

https://docs.joinmastodon.org/methods/filters/#keywords-update

View Source
const PutFilter_V1 = WriteFilters

https://docs.joinmastodon.org/methods/filters/#update-v1

View Source
const PutList = WriteLists

https://docs.joinmastodon.org/methods/lists/#update

View Source
const PutScheduledStatus = WriteStatuses

https://docs.joinmastodon.org/methods/scheduled_statuses/#update

View Source
const PutStatus = WriteStatuses

https://docs.joinmastodon.org/methods/statuses/#edit

View Source
const Read = "read"

https://docs.joinmastodon.org/api/oauth-scopes/#read

View Source
const ReadAccounts = "read:accounts"
View Source
const ReadBlocks = "read:blocks"
View Source
const ReadBookmarks = "read:bookmarks"
View Source
const ReadFavourites = "read:favourites"
View Source
const ReadFilters = "read:filters"
View Source
const ReadFollows = "read:follows"
View Source
const ReadLists = "read:lists"
View Source
const ReadMutes = "read:mutes"
View Source
const ReadNotifications = "read:notifications"
View Source
const ReadSearch = "read:search"
View Source
const ReadStatuses = "read:statuses"
View Source
const Write = "write"

https://docs.joinmastodon.org/api/oauth-scopes/#write

View Source
const WriteAccounts = "write:accounts"
View Source
const WriteBlocks = "write:blocks"
View Source
const WriteBookmarks = "write:bookmarks"
View Source
const WriteConversations = "write:conversations"
View Source
const WriteFavourites = "write:favourites"
View Source
const WriteFilters = "write:filters"
View Source
const WriteFollows = "write:follows"
View Source
const WriteLists = "write:lists"
View Source
const WriteMedia = "write:media"
View Source
const WriteMutes = "write:mutes"
View Source
const WriteNotifications = "write:notifications"
View Source
const WriteReports = "write:reports"
View Source
const WriteStatuses = "write:statuses"

Variables

This section is empty.

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL