documentation/proofs.md at a21d5807f5b016186947e48d51d16fbb58a28b94

mirror of https://github.com/mastodon/documentation synced 2025-04-11 22:56:17 +02:00

Document new OAuth changes for 4.3.0 (#1445 )

* 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>

2024-10-10 14:44:19 +02:00

1.6 KiB

Raw Blame History

title

description

aliases

proofs API methods

For use by identity providers.

docs

weight	name	parent	identifier
100	proofs	methods	methods-proofs

/methods/proofs

/api/methods/proofs

/methods/accounts/proofs

{{< hint style="danger" >}} Deprecated
Identity proofs have been deprecated in 3.5.0 and newer. Previously, the only proof provider was Keybase, but development on Keybase has stalled entirely since it was acquired by Zoom. {{< /hint >}}

View identity proofs {{%removed%}}

GET /api/proofs HTTP/1.1

Returns: custom response defined by provider
OAuth: Public
Version history:
2.8.0 - added

Request

Query parameters

provider: String. The identity provider to be looked up. Currently only supports keybase (case-sensitive).
username: String. The username on the selected identity provider.

Response

200: OK

Looking up the username "gargron" via the "keybase" provider

{
  "avatar": "https://files.mastodon.social/accounts/avatars/000/000/001/original/d96d39a0abb45b92.jpg",
  "signatures": [
    {
      "sig_hash": "5cfc20c7018f2beefb42a68836da59a792e55daa4d118498c9b1898de7e845690f",
      "kb_username": "gargron"
    }
  ]
}

404: Not found

No identity proof found for username on provider

{
  "error": "Record not found"
}

1.6 KiB Raw Blame History