wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix all naming cases of "identity service"

Browse source 
Fixes https://github.com/matrix-org/matrix-doc/issues/1396

Includes some "homeserver" fixes too. This commit does not include historical documentation or notes.
This commit is contained in:
Travis Ralston 2018-08-30 18:19:35 -06:00
parent 683072e624
commit cc0badaaa1
14 changed files with 90 additions and 90 deletions
Download patch file Download diff file Expand all files Collapse all files

14
api/client-server/administrative_contact.yaml
View file

@ -35,7 +35,7 @@ paths:
associated with the user's account.
This is *not* the same as the list of third party identifiers bound to
the user's Matrix ID in Identity Servers.
the user's Matrix ID in Identity Services.
Identifiers in this list may be used by the homeserver as, for example,
identifiers that it will accept to reset the user's account password.
@ -106,13 +106,13 @@ paths:
properties:
client_secret:
type: string
description: The client secret used in the session with the Identity Server.
description: The client secret used in the session with the Identity Service.
id_server:
type: string
description: The Identity Server to use.
description: The Identity Service to use.
sid:
type: string
description: The session identifier given by the Identity Server.
description: The session identifier given by the Identity Service.
required: ["client_secret", "id_server", "sid"]
bind:
type: boolean
@ -138,11 +138,11 @@ paths:
schema:
type: object
403:
description: The credentials could not be verified with the identity server.
description: The credentials could not be verified with the identity service.
examples:
application/json: {
"errcode": "M_THREEPID_AUTH_FAILED",
"error": "The third party credentials could not be verified by the identity server."
"error": "The third party credentials could not be verified by the identity service."
}
schema:
"$ref": "definitions/errors/error.yaml"
@ -243,7 +243,7 @@ paths:
description: |-
Proxies the identity service API ``validate/msisdn/requestToken``, but
first checks that the given phone number is **not** already associated
with an account on this Home Server. This API should be used to request
with an account on this homeserver. This API should be used to request
validation tokens when adding a phone number to an account. This API's
parameters and response are identical to that of the |/register/msisdn/requestToken|_
endpoint.

12
api/client-server/create_room.yaml
View file

@ -41,7 +41,7 @@ paths:
0. A default ``m.room.power_levels`` event, giving the room creator
(and not other members) permission to send state events. Overridden
by the ``power_level_content_override`` parameter.
1. Events set by the ``preset``. Currently these are the ``m.room.join_rules``,
``m.room.history_visibility``, and ``m.room.guest_access`` state events.
@ -59,13 +59,13 @@ paths:
======================== ============== ====================== ================ =========
Preset ``join_rules`` ``history_visibility`` ``guest_access`` Other
======================== ============== ====================== ================ =========
``private_chat`` ``invite`` ``shared`` ``can_join``
``private_chat`` ``invite`` ``shared`` ``can_join``
``trusted_private_chat`` ``invite`` ``shared`` ``can_join`` All invitees are given the same power level as the room creator.
``public_chat`` ``public`` ``shared`` ``forbidden``
``public_chat`` ``public`` ``shared`` ``forbidden``
======================== ============== ====================== ================ =========
The server will create a ``m.room.create`` event in the room with the
requesting user as the creator, alongside other keys provided in the
requesting user as the creator, alongside other keys provided in the
``creation_content``.
operationId: createRoom
security:
@ -138,7 +138,7 @@ paths:
properties:
id_server:
type: string
description: The hostname+port of the identity server which should be used for third party identifier lookups.
description: The hostname+port of the identity service which should be used for third party identifier lookups.
medium:
type: string
# TODO: Link to identity service spec when it eixsts
@ -196,7 +196,7 @@ paths:
If unspecified, the server should use the ``visibility`` to determine
which preset to use. A visbility of ``public`` equates to a preset of
``public_chat`` and ``private`` visibility equates to a preset of
``public_chat`` and ``private`` visibility equates to a preset of
``private_chat``.
is_direct:
type: boolean

6
api/client-server/definitions/wellknown/identity_server.yaml
View file

@ -11,14 +11,14 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
title: Identity Server Information
title: Identity Service Information
description: |-
Used by clients to discover identity server information.
Used by clients to discover identity service information.
type: object
properties:
base_url:
type: string
description: The base URL for the identity server for client-server connections.
description: The base URL for the identity service for client-server connections.
example: https://identity.example.com
required:
- base_url

16
api/client-server/registration.yaml
View file

@ -92,7 +92,7 @@ paths:
type: boolean
description: |-
If true, the server binds the email used for authentication to
the Matrix ID with the ID Server.
the Matrix ID with the identity service.
example: false
username:
type: string
@ -251,7 +251,7 @@ paths:
instead send an email to the user with instructions on how to reset their password.
This prevents malicious parties from being able to determine if a given email address
has an account on the homeserver in question.
* ``M_SERVER_NOT_TRUSTED`` : The ``id_server`` parameter refers to an ID server
* ``M_SERVER_NOT_TRUSTED`` : The ``id_server`` parameter refers to an identity service
that is not trusted by this homeserver.
examples:
application/json: {
@ -307,12 +307,12 @@ paths:
Part of the request was invalid. This may include one of the following error codes:
* ``M_THREEPID_IN_USE`` : The phone number is already registered to an account on this server.
However, if the home server has the ability to send SMS message, it is recommended that the server
However, if the homeserver has the ability to send SMS message, it is recommended that the server
instead send an SMS message to the user with instructions on how to reset their password.
This prevents malicious parties from being able to determine if a given phone number
has an account on the Home Server in question.
* ``M_SERVER_NOT_TRUSTED`` : The ``id_server`` parameter refers to an ID server
that is not trusted by this Home Server.
has an account on the homeserver in question.
* ``M_SERVER_NOT_TRUSTED`` : The ``id_server`` parameter refers to an identity service
that is not trusted by this homeserver.
examples:
application/json: {
"errcode": "M_THREEPID_IN_USE",
@ -375,7 +375,7 @@ paths:
description: |-
Proxies the identity service API ``validate/email/requestToken``, but
first checks that the given email address **is** associated with an account
on this Home Server. This API should be used to request
on this homeserver. This API should be used to request
validation tokens when authenticating for the
`account/password` endpoint. This API's parameters and response are
identical to that of the HS API |/register/email/requestToken|_ except that
@ -437,7 +437,7 @@ paths:
description: |-
Proxies the identity service API ``validate/msisdn/requestToken``, but
first checks that the given phone number **is** associated with an account
on this Home Server. This API should be used to request
on this homeserver. This API should be used to request
validation tokens when authenticating for the
`account/password` endpoint. This API's parameters and response are
identical to that of the HS API |/register/msisdn/requestToken|_ except that

16
api/client-server/third_party_membership.yaml
View file

@ -36,7 +36,7 @@ paths:
*Note that there are two forms of this API, which are documented separately.
This version of the API does not require that the inviter know the Matrix
identifier of the invitee, and instead relies on third party identifiers.
The homeserver uses an identity server to perform the mapping from
The homeserver uses an identity service to perform the mapping from
third party identifier to a Matrix identifier. The other is documented in the*
`joining rooms section`_.
@ -47,31 +47,31 @@ paths:
Only users currently in a particular room can invite other users to
join that room.
If the identity server did know the Matrix user identifier for the
If the identity service did know the Matrix user identifier for the
third party identifier, the homeserver will append a ``m.room.member``
event to the room.
If the identity server does not know a Matrix user identifier for the
If the identity service does not know a Matrix user identifier for the
passed third party identifier, the homeserver will issue an invitation
which can be accepted upon providing proof of ownership of the third
party identifier. This is achieved by the identity server generating a
party identifier. This is achieved by the identity service generating a
token, which it gives to the inviting homeserver. The homeserver will
add an ``m.room.third_party_invite`` event into the graph for the room,
containing that token.
When the invitee binds the invited third party identifier to a Matrix
user ID, the identity server will give the user a list of pending
user ID, the identity service will give the user a list of pending
invitations, each containing:
- The room ID to which they were invited
- The token given to the homeserver
- A signature of the token, signed with the identity server's private key
- A signature of the token, signed with the identity service's private key
- The matrix user ID who invited them to the room
If a token is requested from the identity server, the homeserver will
If a token is requested from the identity service, the homeserver will
append a ``m.room.third_party_invite`` event to the room.
.. _joining rooms section: `invite-by-user-id-endpoint`_
@ -98,7 +98,7 @@ paths:
properties:
id_server:
type: string
description: The hostname+port of the identity server which should be used for third party identifier lookups.
description: The hostname+port of the identity service which should be used for third party identifier lookups.
medium:
type: string
# TODO: Link to identity service spec when it eixsts

2
api/client-server/wellknown.yaml
View file

@ -54,7 +54,7 @@ paths:
description: Information about the homeserver to connect to.
"$ref": "definitions/wellknown/homeserver.yaml"
m.identity_server:
description: Optional. Information about the identity server to connect to.
description: Optional. Information about the identity service to connect to.
"$ref": "definitions/wellknown/identity_server.yaml"
additionalProperties:
description: Application-dependent keys using Java package naming convention.

18
api/server-server/third_party_invite.yaml
View file

@ -200,9 +200,9 @@ paths:
Notifies the server that a third party identifier has been bound to one
of its users.
description: |-
Used by Identity Servers to notify the homeserver that one of its users
Used by Identity Services to notify the homeserver that one of its users
has bound a third party identifier successfully, including any pending
room invites the Identity Server has been made aware of.
room invites the Identity Service has been made aware of.
operationId: onBindThirdPartyIdentifier
parameters:
- in: body
@ -262,9 +262,9 @@ paths:
# also make sure it isn't lying about anything, like the key version
signed:
type: object
title: Identity Server Signatures
title: Identity Service Signatures
description: |-
Signature from the Identity Server using a long-term private
Signature from the Identity Service using a long-term private
key.
properties:
mxid:
@ -280,14 +280,14 @@ paths:
example: "Hello World"
signatures:
type: object
title: Identity Server Signature
title: Identity Service Signature
description: |-
The signature from the identity server. The ``string`` key
is the identity server's domain name, such as vector.im
The signature from the identity service. The ``string`` key
is the identity service's domain name, such as vector.im
additionalProperties:
type: object
title: Identity Server Domain Signature
description: The signature for the identity server.
title: Identity Service Domain Signature
description: The signature for the identity service.
properties:
"ed25519:0":
type: string