mirror of
https://github.com/mastodon/documentation
synced 2025-04-11 22:56:17 +02:00
ffbe66a389
* fix relrefs around trends and related entities * revert moving caption-links to middle of page * hide empty menu in table of contents * clarify edit notifs are only for boosted statuses * following/followers no longer need auth * fix typo * specify cooldown period for account Move * use the correct cooldown * add missing parameters to accounts/id/statuses * link to account_statuses_filter.rb * fix typo (#1072) * fix typo (#1073) * fix link to http sig spec (#1067) * simply HTTP request examples in api methods docs * add missing client_secret to oauth/token (#1062) * Add any, all, none to hashtag timeline * minor formatting changes * Update signature requirements and advice * fix public key -> private key * clarify use of RSA with SHA256 * Add note about saving your profile after adding rel-me link * v2 filters api * comment out params that shouldn't be used in v2 filter api * admin trends * remove old todo * canonical email blocks + scheduled statuses * remove under-construction warnings from finished pages * verify api method params with source code * fix typo (#1088) * fix broken caption-links (#1100) * fix formatting of entities (#1094) * Remove keybase section from user guide (#1093) * fix typos (#1092) * Verify limits are accurate (#1086) * add mention of iframe limitation (#1084) * Add CORS header to WEB_DOMAIN example (#1083) * Fix typo (#1081) * pin http sigs spec at draft 8 * Revert "pin http sigs spec at draft 8" This reverts commit 9fd5f7032b69b29e77599dd62adfe8d2f5cd4f20. * add case sensitivity warning to 4.0 roles * Add url length note to bio (#1087) * remove follow scope from examples (#1103) * clarify usage of update_credentials to update profile fields * add noindex to Account entitity * remove required hint from technically not required property
69 lines
1.8 KiB
Markdown
69 lines
1.8 KiB
Markdown
---
|
|
title: Application
|
|
description: Represents an application that interfaces with the REST API to access accounts or post statuses.
|
|
menu:
|
|
docs:
|
|
parent: entities
|
|
aliases: [
|
|
"/entities/application",
|
|
"/entities/Application",
|
|
"/api/entities/application",
|
|
"/api/entities/Application",
|
|
]
|
|
---
|
|
|
|
## Example
|
|
|
|
```json
|
|
{
|
|
"name": "test app",
|
|
"website": null,
|
|
"vapid_key": "BCk-QqERU0q-CfYZjcuB6lnyyOYfJ2AifKqfeGIm7Z-HiTU5T9eTG5GxVA0_OH5mMlI4UkkDTpaZwozy0TzdZ2M="
|
|
}
|
|
```
|
|
|
|
## Attributes
|
|
|
|
### `name` {#name}
|
|
|
|
**Description:** The name of your application.\
|
|
**Type:** String\
|
|
**Version history:**\
|
|
0.9.9 - added
|
|
|
|
### `website` {{%optional%}} {#website}
|
|
|
|
**Description:** The website associated with your application.\
|
|
**Type:** {{<nullable>}} String (URL)\
|
|
**Version history:**\
|
|
0.9.9 - added\
|
|
3.5.1 - this property is now nullable
|
|
|
|
### `vapid_key` {#vapid_key}
|
|
|
|
**Description:** Used for Push Streaming API. Returned with [POST /api/v1/apps]({{< relref "methods/apps#create" >}}). Equivalent to [WebPushSubscription#server_key]({{< relref "entities/WebPushSubscription#server_key" >}})\
|
|
**Type:** String\
|
|
**Version history:**\
|
|
2.8.0 - added
|
|
|
|
### `client_id` {{%optional%}} {#client_id}
|
|
|
|
**Description:** Client ID key, to be used for obtaining OAuth tokens\
|
|
**Type:** String\
|
|
**Version history:**\
|
|
0.9.9 - added
|
|
|
|
### `client_secret` {{%optional%}} {#client_secret}
|
|
|
|
**Description:** Client secret key, to be used for obtaining OAuth tokens\
|
|
**Type:** String\
|
|
**Version history:**\
|
|
0.9.9 - added
|
|
|
|
## See also
|
|
|
|
{{< page-relref ref="methods/apps" caption="apps API methods" >}}
|
|
|
|
{{< page-relref ref="entities/Status#application" caption="Status (`application` attribute)" >}}
|
|
|
|
{{< caption-link url="https://github.com/mastodon/mastodon/blob/master/app/serializers/rest/application_serializer.rb" caption="app/serializers/rest/application_serializer.rb" >}} |