documentation/content/en/entities/admin-account.md

131 lines
3.2 KiB
Markdown
Raw Normal View History

---
title: Admin::Account
description: Admin-level information about a given account.
menu:
docs:
parent: entities
---
## Example
```javascript
{}
```
## Attributes
### `id` {#id"></a>
**Description:** The ID of the account in the database.\
**Type:** String \(cast from an integer, but not guaranteed to be a number\)\
**Version history:** Added in 2.9.1
### `username` {#username"></a>
**Description:** The username of the account.\
**Type:** String\
**Version history:** Added in 2.9.1
### `domain` {#domain"></a>
**Description:** The domain of the account.\
**Type:** String\
**Version history:** Added in 2.9.1
### `created_at` {#created_at"></a>
**Description:** When the account was first discovered.\
**Type:** String \(ISO 8601 Datetime\)\
**Version history:** Added in 2.9.1
### `email` {#email"></a>
**Description:** The email address associated with the account.\
**Type:** String\
**Version history:** Added in 2.9.1
### `ip` {#ip"></a>
**Description:** The IP address last used to login to this account.\
**Type:** String\
**Version history:** Added in 2.9.1
### `locale` {#locale"></a>
**Description:** The locale of the account.\
**Type:** String \(ISO 639 Part 1 two-letter language code\)\
**Version history:** Added in 2.9.1
### `invite_request` {#invite_request"></a>
**Description:** Invite request text ???\
**Type:** String\
**Version history:** Added in 2.9.1
## State attributes
### `role` {#role"></a>
**Description:** The current role of the account.\
**Type:** String \(Enumerable oneOf\)\
**Version history:** Added in 2.9.1
### `confirmed` {#confirmed"></a>
**Description:** Whether the account has confirmed their email address.\
**Type:** Boolean\
**Version history:** Added in 2.9.1
### `approved` {#approved"></a>
**Description:** Whether the account is currently approved.\
**Type:** Boolean\
**Version history:** Added in 2.9.1
### `disabled` {#disabled"></a>
**Description:** Whether the account is currently disabled.\
**Type:** Boolean\
**Version history:** Added in 2.9.1
### `silenced` {#silenced"></a>
**Description:** Whether the account is currently silenced.
**Type:** Boolean\
**Version history:** Added in 2.9.1
### `suspended` {#suspended"></a>
**Description:** Whether the account is currently suspended.\
**Type:** Boolean\
**Version history:** Added in 2.9.1
### `account` {#account"></a>
**Description:** User-level information about the account.\
**Type:** Account\
**Version history:** Added in 2.9.1
## Nullable attributes
### `created_by_application_id` {#created_by_application_id"></a>
**Description:** The ID of the application that created this account.\
**Type:** String \(cast from an integer, but not guaranteed to be a number\)\
**Version history:** Added in 2.9.1
### `invited_by_account_id` {#invited_by_account_id"></a>
**Description:** The ID of the account that invited this user\
**Type:** String \(cast from an integer, but not guaranteed to be a number\)\
**Version history:** Added in 2.9.1
## See also
{{< page-ref page="methods/admin.md" >}}
{{< caption-link url="https://github.com/tootsuite/mastodon/blob/master/app/serializers/rest/admin/account_serializer.rb" caption="app/serializers/rest/admin/account\_serializer.rb" >}}