Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-05 03:04:11 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Reference the v2 API where possible

Browse source
This commit is contained in:
Travis Ralston 2019-08-28 14:18:11 -06:00
parent a47c5aeb42
commit b0acaeddfa
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
specification/identity_service_api.rst
View file

@ -57,6 +57,8 @@ The following other versions are also available, in reverse chronological order:
General principles General principles
------------------ ------------------
.. TODO: TravisR - Define auth for IS v2 API in a future PR
The purpose of an identity server is to validate, store, and answer questions The purpose of an identity server is to validate, store, and answer questions
about the identities of users. In particular, it stores associations of the form about the identities of users. In particular, it stores associations of the form
"identifier X represents the same user as identifier Y", where identities may "identifier X represents the same user as identifier Y", where identities may
@ -176,6 +178,8 @@ Status check
{{ping_is_http_api}} {{ping_is_http_api}}
{{v2_ping_is_http_api}}
Key management Key management
-------------- --------------
@ -195,11 +199,15 @@ service's long-term keys.
{{pubkey_is_http_api}} {{pubkey_is_http_api}}
{{v2_pubkey_is_http_api}}
Association lookup Association lookup
------------------ ------------------
{{lookup_is_http_api}} {{lookup_is_http_api}}
.. TODO: TravisR - Add v2 lookup API in future PR
Establishing associations Establishing associations
------------------------- -------------------------
@ -243,16 +251,22 @@ Email associations
{{email_associations_is_http_api}} {{email_associations_is_http_api}}
{{v2_email_associations_is_http_api}}
Phone number associations Phone number associations
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
{{phone_associations_is_http_api}} {{phone_associations_is_http_api}}
{{v2_phone_associations_is_http_api}}
General General
~~~~~~~ ~~~~~~~
{{associations_is_http_api}} {{associations_is_http_api}}
{{v2_associations_is_http_api}}
Invitation storage Invitation storage
------------------ ------------------
@ -267,6 +281,8 @@ long-term private key for the identity server.
{{store_invite_is_http_api}} {{store_invite_is_http_api}}
{{v2_store_invite_is_http_api}}
Ephemeral invitation signing Ephemeral invitation signing
---------------------------- ----------------------------
@ -277,6 +293,8 @@ this isn't possible.
{{invitation_signing_is_http_api}} {{invitation_signing_is_http_api}}
{{v2_invitation_signing_is_http_api}}
.. _`Unpadded Base64`: ../appendices.html#unpadded-base64 .. _`Unpadded Base64`: ../appendices.html#unpadded-base64
.. _`3PID Types`: ../appendices.html#pid-types .. _`3PID Types`: ../appendices.html#pid-types
.. _`Signing JSON`: ../appendices.html#signing-json .. _`Signing JSON`: ../appendices.html#signing-json