mirror of
https://github.com/mastodon/documentation
synced 2025-04-11 22:56:17 +02:00
cb3aa4de10
* Improve deprecation messaging for Application#vapid_key * Format JSON examples in Instance methods * Remove vapid_key from Apps API examples, since this property is deprecated on Application entity * Add documentation for new OAuth 2.0 features added in 4.3.0 * Improve documentation for oauth-scopes * Update content/en/api/oauth-scopes.md Co-authored-by: Matt Jankowski <matt@jankowski.online> * Update content/en/api/oauth-scopes.md Co-authored-by: Matt Jankowski <matt@jankowski.online> * Update content/en/api/oauth-scopes.md Co-authored-by: Matt Jankowski <matt@jankowski.online> * Update content/en/api/oauth-scopes.md Co-authored-by: Matt Jankowski <matt@jankowski.online> * Add deprecated and removed shortcode labels * Use deprecated and removed shortcodes * Improve OAuth documentation * More OAuth documentation improvements * Correct streaming API documentation after 4.2.0 changes * Add note about improved Push Subscription API validation in 4.3.0 * Fix inconsistent OAuth label formatting * Add note that there is a relationship between Accounts and the Application used to create them * Add note that application registration endpoint also supports JSON bodies * Be consistent in the formatting of placeholder values for Bearer tokens * code review changes * Slight changes in wording * Add documentation for PKCE * Removal of crypto oauth scope * Cross-link authorization's scope with the OAuth Scopes documentation * Update content/en/methods/oauth.md * Update content/en/api/oauth-scopes.md --------- Co-authored-by: Matt Jankowski <matt@jankowski.online> Co-authored-by: David Roetzel <david@roetzel.de>
179 lines
3.9 KiB
Markdown
179 lines
3.9 KiB
Markdown
---
|
|
title: profile API methods
|
|
description: Methods concerning profiles.
|
|
menu:
|
|
docs:
|
|
weight: 20
|
|
name: profile
|
|
parent: methods
|
|
identifier: methods-profile
|
|
---
|
|
|
|
<style>
|
|
#TableOfContents ul ul ul {display: none}
|
|
</style>
|
|
|
|
## Delete profile avatar
|
|
|
|
```http
|
|
DELETE /api/v1/profile/avatar HTTP/1.1
|
|
```
|
|
|
|
**Returns:** [CredentialAccount]({{< relref "entities/Account#CredentialAccount">}})\
|
|
**OAuth:** User token + `write:accounts`\
|
|
**Version history:**\
|
|
4.2.0 - added
|
|
|
|
Deletes the avatar associated with the user's profile.
|
|
|
|
#### Request
|
|
|
|
##### Headers
|
|
|
|
Authorization
|
|
: {{<required>}} Provide this header with `Bearer <user_token>` to gain authorized access to this API method.
|
|
|
|
##### Path parameters
|
|
|
|
#### Response
|
|
|
|
##### 200: OK
|
|
|
|
The avatar was successfully deleted from the user's profile. If there were no avatar associated with the profile, the response will still indicate a successful deletion.
|
|
|
|
```json
|
|
{
|
|
"id": "110357222516183152",
|
|
"username": "rob",
|
|
"acct": "rob",
|
|
"display_name": "",
|
|
"locked": false,
|
|
"bot": false,
|
|
"discoverable": false,
|
|
"group": false,
|
|
"created_at": "2023-05-12T00:00:00.000Z",
|
|
"note": "",
|
|
"url": "http://localhost:3000/@rob",
|
|
"uri": "http://localhost:3000/users/rob",
|
|
"avatar": "http://localhost:3000/avatars/original/missing.png",
|
|
"avatar_static": "http://localhost:3000/avatars/original/missing.png",
|
|
"header": "http://localhost:3000/system/accounts/headers/110/357/222/516/183/152/original/0cd99648c23005ed.png",
|
|
"header_static": "http://localhost:3000/system/accounts/headers/110/357/222/516/183/152/original/0cd99648c23005ed.png",
|
|
"followers_count": 14,
|
|
"following_count": 2,
|
|
"statuses_count": 10,
|
|
"last_status_at": "2023-06-26",
|
|
"noindex": false,
|
|
"source": {
|
|
"privacy": "public",
|
|
"sensitive": false,
|
|
"language": null,
|
|
"note": "",
|
|
"fields": [],
|
|
"follow_requests_count": 0
|
|
},
|
|
"emojis": [],
|
|
"roles": [],
|
|
"fields": [],
|
|
"role": {
|
|
"id": "-99",
|
|
"name": "",
|
|
"permissions": "65536",
|
|
"color": "",
|
|
"highlighted": false
|
|
}
|
|
}
|
|
```
|
|
|
|
### 401: Unauthorized
|
|
|
|
Invalid or missing Authorization header.
|
|
|
|
```json
|
|
{
|
|
"error": "The access token is invalid"
|
|
}
|
|
```
|
|
|
|
## Delete profile header
|
|
|
|
```http
|
|
DELETE /api/v1/profile/header HTTP/1.1
|
|
```
|
|
|
|
**Returns:** [CredentialAccount]({{< relref "entities/Account#CredentialAccount">}})\
|
|
**OAuth:** User token + `write:accounts`\
|
|
**Version history:**\
|
|
4.2.0 - added
|
|
|
|
Deletes the header image associated with the user's profile.
|
|
|
|
#### Request
|
|
|
|
##### Headers
|
|
|
|
Authorization
|
|
: {{<required>}} Provide this header with `Bearer <user_token>` to gain authorized access to this API method.
|
|
|
|
##### Path parameters
|
|
|
|
#### Response
|
|
|
|
##### 200: OK
|
|
|
|
The header was successfully deleted from the user's profile. If there were no header associated with the profile, the response will still indicate a successful deletion.
|
|
|
|
```json
|
|
{
|
|
"id": "110357222516183152",
|
|
"username": "rob",
|
|
"acct": "rob",
|
|
"display_name": "",
|
|
"locked": false,
|
|
"bot": false,
|
|
"discoverable": false,
|
|
"group": false,
|
|
"created_at": "2023-05-12T00:00:00.000Z",
|
|
"note": "",
|
|
"url": "http://localhost:3000/@rob",
|
|
"uri": "http://localhost:3000/users/rob",
|
|
"avatar": "http://localhost:3000/avatars/original/missing.png",
|
|
"avatar_static": "http://localhost:3000/avatars/original/missing.png",
|
|
"header": "http://localhost:3000/headers/original/missing.png",
|
|
"header_static": "http://localhost:3000/headers/original/missing.png",
|
|
"followers_count": 14,
|
|
"following_count": 2,
|
|
"statuses_count": 10,
|
|
"last_status_at": "2023-06-26",
|
|
"noindex": false,
|
|
"source": {
|
|
"privacy": "public",
|
|
"sensitive": false,
|
|
"language": null,
|
|
"note": "",
|
|
"fields": [],
|
|
"follow_requests_count": 0
|
|
},
|
|
"emojis": [],
|
|
"roles": [],
|
|
"fields": [],
|
|
"role": {
|
|
"id": "-99",
|
|
"name": "",
|
|
"permissions": "65536",
|
|
"color": "",
|
|
"highlighted": false
|
|
}
|
|
}
|
|
```
|
|
|
|
### 401: Unauthorized
|
|
|
|
Invalid or missing Authorization header.
|
|
|
|
```json
|
|
{
|
|
"error": "The access token is invalid"
|
|
}
|
|
```
|