Update content for 4.0 (part 1) (#991)
* add rules * join date on profiles * deprecate follow scope * deprecate identity proofs * familiar followers * use definition lists instead of tables for defining activitypub properties * reformat notifications page into markdown * fix broken links to publicKey header * Application website is now nullable * update environment variables added and removed * fix typo * fix heading level * min_id and max_id can be used at the same time (3.3) * fix typo * new tootctl options * reformat tootctl page to use definition lists for params * add rules and configuration to Instance * fix typo * refactor instance api page * 3.3.0 duration on mutes * 3.3.0 mute_expires_at * improve section headings * 3.4.0 resend email confirmation api * 3.4.0 policy on push subscriptions * 3.4.0 add details to account registration error * refactor accounts api page and start adding relrefs to entity pages * 3.4.0 accounts/lookup api * add see also to accounts methods * add more see-also links * 3.5.0 appeal mod decisions * 3.5.0 reformat reports and add category/rule_ids params * document report entity and missing responses * fix typos * fix relrefs and url schema, add aliases to old urls * add archetypes for new methods/entities * update archetypes with see-also stubs * clearer presentation of rate limits * announcements api methods * refactor apps methods * refactor bookmarks methods + some anchors * refactor conversations methods * custom_emojis methods refactor * anchors * refactor directory methods * refactor domain_blocks methods * add see also to emails methods * fix page relref shortcodes to specific methods + refactor endorsements methods * min_id max_id * refactor favourites methods * refactor featured_tags methods * refactor filters methods, make path params consistent, i18n required shortcode * follow_requests methods * lists methods * markers methods * forgot to add entity links * media methods, also fix formatting of some json errors * mutes methods, add more see-also links * oembed methods * preferences methods * proofs methods * push methods * suggestions methods * 3.5.0 add new trend types, fix formatting * refactor streaming methods * refactor oauth methods * note that streaming api casts payload to string * refactor search methods * refactor polls methods * remove unnecessary link * reformat scheduled_statuses methods * reformat timelines methods * reformat statuses methods * 3.5.0 editing statuses * consistent use of array brackets in form data parameters * update dev setup guide, add vagrant and clean up text * add admin/accounts methods * 3.6 role entity * admin/accounts methods v2 * minor fix * stub admin/reports methods * document admin reports * add 403 example to methods archetype * cleanup entities for admin reports and add new attrs * 3.6.0 domain allows methods + normalize admin entity namespace * fix search-and-replace error * add aliases for admin entities * 3.6.0 canonical email blocks entity * 3.5.0 admin/retention api * 3.5.0 add admin::ip doc * 3.5.0 admin/reports * 3.6.0 admin/domain_allows * 3.5.0 admin/dimensions * 3.6.0 permissions and roles * minor formatting fix * add anchor link to headings * checkpoint * add update commands to dev env setup guide * change mentions of v3.6 to v4.0 * tootctl now uses custom roles * fix formatting * v2 instance api * update frontmatter, add better titles to pages * minor wording change * consistency * add more aliases * add placeholders and WIP notices * explain link pagination and stub out todos * switch baseURL to https * 422 on reports with rules but category!=violation * document bug fixes * fix typo * remove duplicate API method definition * s/tootsuite/mastodon for github links * remove unnecessary escaping * s/tootsuite/mastodon in Entity archetype * add missing nullable shortcode * clarify oauth scope when requesting a user token * api/v2/media now synchronous for images * DISALLOW_UNAUTHENTICATED_API_ACCESS * add undocumented env variables * add instance domain blocks and extended description api * add SMTP_ENABLE_STARTTLS * add description to SMTP_ENABLE_STARTTLS * take suggestions from open PRs * normalize links and flavour language * Fully document streaming API based on source code * Add mention of MIME types * bump to ruby 3.0.4 * clarify how to check on async media processing * validation of replies_policy * remove TODOs on admin account action * EmailDomainBlocks * IpBlocks * Admin::DomainBlock * remove TODOs * following hashtags * followed_tags * remove reference to unused parameter * add new oauth scopes for admin blocks and allows * fix command signature for i18n-tasks normalize * reformat code structure page * document fixes for following tags (assume 4.0.3) * Add warning about pre-4.0 hardcoded roles * add note about case sensitivity * remove use of 'simply' from docs * remove reference to silencing * add reference to IDN normalization for verified links * add lang parameter
This commit is contained in:
trwnh
GitHub
parent
69e9017730
commit
3628b6d434
225 changed files with 22675 additions and 11631 deletions
213
content/en/entities/Admin_Account.md
Normal file
213
content/en/entities/Admin_Account.md
Normal file
|
|
@ -0,0 +1,213 @@
|
|||
---
|
||||
title: Admin::Account
|
||||
description: Admin-level information about a given account.
|
||||
menu:
|
||||
docs:
|
||||
parent: entities
|
||||
aliases: [
|
||||
"/entities/admin-account",
|
||||
"/entities/Admin-Account",
|
||||
"/entities/admin_account",
|
||||
"/entities/Admin_Account",
|
||||
"/api/entities/admin-account",
|
||||
"/api/entities/Admin-Account",
|
||||
"/api/entities/admin_account",
|
||||
"/api/entities/Admin_Account",
|
||||
]
|
||||
---
|
||||
|
||||
## Example
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "108965278956942133",
|
||||
"username": "admin",
|
||||
"domain": null,
|
||||
"created_at": "2022-09-08T23:03:26.762Z",
|
||||
"email": "admin@mastodon.local",
|
||||
"ip": "192.168.42.1",
|
||||
"role": {
|
||||
"id": 3,
|
||||
"name": "Owner",
|
||||
"color": "",
|
||||
"position": 1000,
|
||||
"permissions": 1,
|
||||
"highlighted": true,
|
||||
"created_at": "2022-09-08T22:48:07.983Z",
|
||||
"updated_at": "2022-09-08T22:48:07.983Z"
|
||||
},
|
||||
"confirmed": true,
|
||||
"suspended": false,
|
||||
"silenced": false,
|
||||
"disabled": false,
|
||||
"approved": true,
|
||||
"locale": null,
|
||||
"invite_request": null,
|
||||
"ips": [
|
||||
{
|
||||
"ip": "192.168.42.1",
|
||||
"used_at": "2022-09-15T01:38:58.851Z"
|
||||
}
|
||||
],
|
||||
"account": {
|
||||
"id": "108965278956942133",
|
||||
"username": "admin",
|
||||
"acct": "admin",
|
||||
"display_name": "",
|
||||
"locked": false,
|
||||
"bot": false,
|
||||
"discoverable": null,
|
||||
"group": false,
|
||||
"created_at": "2022-09-08T00:00:00.000Z",
|
||||
"note": "",
|
||||
"url": "http://mastodon.local/@admin",
|
||||
"avatar": "http://mastodon.local/avatars/original/missing.png",
|
||||
"avatar_static": "http://mastodon.local/avatars/original/missing.png",
|
||||
"header": "http://mastodon.local/headers/original/missing.png",
|
||||
"header_static": "http://mastodon.local/headers/original/missing.png",
|
||||
"followers_count": 0,
|
||||
"following_count": 0,
|
||||
"statuses_count": 0,
|
||||
"last_status_at": null,
|
||||
"emojis": [],
|
||||
"fields": []
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Attributes
|
||||
|
||||
### `id` {#id}
|
||||
|
||||
**Description:** The ID of the account in the database.\
|
||||
**Type:** String (cast from an integer, but not guaranteed to be a number)\
|
||||
**Version history:**\
|
||||
2.9.1 - added
|
||||
|
||||
### `username` {#username}
|
||||
|
||||
**Description:** The username of the account.\
|
||||
**Type:** String\
|
||||
**Version history:**\
|
||||
2.9.1 - added
|
||||
|
||||
### `domain` {#domain}
|
||||
|
||||
**Description:** The domain of the account, if it is remote.\
|
||||
**Type:** {{<nullable>}} String, or null for local accounts\
|
||||
**Version history:**\
|
||||
2.9.1 - added
|
||||
|
||||
### `created_at` {#created_at}
|
||||
|
||||
**Description:** When the account was first discovered.\
|
||||
**Type:** String (ISO 8601 Datetime)\
|
||||
**Version history:**\
|
||||
2.9.1 - added
|
||||
|
||||
### `email` {#email}
|
||||
|
||||
**Description:** The email address associated with the account.\
|
||||
**Type:** String\
|
||||
**Version history:**\
|
||||
2.9.1 - added
|
||||
|
||||
### `ip` {#ip}
|
||||
|
||||
**Description:** The IP address last used to login to this account.\
|
||||
**Type:** {{<nullable>}} String\
|
||||
**Version history:**\
|
||||
2.9.1 - added
|
||||
3.5.0 - return type changed from String to [Admin::Ip]({{< relref "entities/Admin_Ip" >}}) due to a bug
|
||||
4.0.0 - bug fixed, return type is now a String again
|
||||
|
||||
### `ips` {#ip}
|
||||
|
||||
**Description:** All known IP addresses associated with this account.\
|
||||
**Type:** Array of [Admin::Ip]({{< relref "entities/Admin_Ip" >}})\
|
||||
**Version history:**\
|
||||
3.5.0 - added
|
||||
|
||||
### `locale` {#locale}
|
||||
|
||||
**Description:** The locale of the account.\
|
||||
**Type:** String (ISO 639 Part 1 two-letter language code)\
|
||||
**Version history:**\
|
||||
2.9.1 - added
|
||||
|
||||
### `invite_request` {#invite_request}
|
||||
|
||||
**Description:** The reason given when requesting an invite (for instances that require manual approval of registrations)\
|
||||
**Type:** {{<nullable>}} String\
|
||||
**Version history:**\
|
||||
2.9.1 - added
|
||||
|
||||
### `role` {#role}
|
||||
|
||||
**Description:** The current role of the account.\
|
||||
**Type:** [Role]({{<relref "entities/role">}})\
|
||||
**Version history:**\
|
||||
2.9.1 - added, returns a String (enumerable, oneOf `user` `moderator` `admin`)
|
||||
4.0.0 - now uses Role entity
|
||||
|
||||
### `confirmed` {#confirmed}
|
||||
|
||||
**Description:** Whether the account has confirmed their email address.\
|
||||
**Type:** Boolean\
|
||||
**Version history:**\
|
||||
2.9.1 - added
|
||||
|
||||
### `approved` {#approved}
|
||||
|
||||
**Description:** Whether the account is currently approved.\
|
||||
**Type:** Boolean\
|
||||
**Version history:**\
|
||||
2.9.1 - added
|
||||
|
||||
### `disabled` {#disabled}
|
||||
|
||||
**Description:** Whether the account is currently disabled.\
|
||||
**Type:** Boolean\
|
||||
**Version history:**\
|
||||
2.9.1 - added
|
||||
|
||||
### `silenced` {#silenced}
|
||||
|
||||
**Description:** Whether the account is currently silenced.
|
||||
**Type:** Boolean\
|
||||
**Version history:**\
|
||||
2.9.1 - added
|
||||
|
||||
### `suspended` {#suspended}
|
||||
|
||||
**Description:** Whether the account is currently suspended.\
|
||||
**Type:** Boolean\
|
||||
**Version history:**\
|
||||
2.9.1 - added
|
||||
|
||||
### `account` {#account}
|
||||
|
||||
**Description:** User-level information about the account.\
|
||||
**Type:** [Account]({{< relref "entities/account" >}})\
|
||||
**Version history:**\
|
||||
2.9.1 - added
|
||||
|
||||
### `created_by_application_id` {{%optional%}} {#created_by_application_id}
|
||||
|
||||
**Description:** The ID of the [Application]({{< relref "entities/application" >}}) that created this account, if applicable.\
|
||||
**Type:** String (cast from an integer, but not guaranteed to be a number)\
|
||||
**Version history:**\
|
||||
2.9.1 - added
|
||||
|
||||
### `invited_by_account_id` {{%optional%}} {#invited_by_account_id}
|
||||
|
||||
**Description:** The ID of the [Account]({{< relref "entities/account" >}}) that invited this user, if applicable.\
|
||||
**Type:** String (cast from an integer, but not guaranteed to be a number)\
|
||||
**Version history:**\
|
||||
2.9.1 - added
|
||||
|
||||
## See also
|
||||
|
||||
{{< page-relref ref="methods/admin/accounts" caption="admin/accounts API methods" >}}
|
||||
|
||||
{{< caption-link url="https://github.com/mastodon/mastodon/blob/master/app/serializers/rest/admin/account_serializer.rb" caption="app/serializers/rest/admin/account_serializer.rb" >}}
|
||||
Loading…
Add table
Add a link
Reference in a new issue