Merge pull request #1567 from turt2live/travis/c2s/3pid-binding
Document `validated_at`, `added_at`, and POST /3pid/delete
This commit is contained in:
commit
ce14779af1
3 changed files with 59 additions and 7 deletions
|
@ -50,7 +50,9 @@ paths:
|
|||
"threepids": [
|
||||
{
|
||||
"medium": "email",
|
||||
"address": "monkey@banana.island"
|
||||
"address": "monkey@banana.island",
|
||||
"validated_at": 1535176800000,
|
||||
"added_at": 1535336848756
|
||||
}
|
||||
]
|
||||
}
|
||||
|
@ -70,6 +72,19 @@ paths:
|
|||
address:
|
||||
type: string
|
||||
description: The third party identifier address.
|
||||
validated_at:
|
||||
type: integer
|
||||
format: int64
|
||||
description: |-
|
||||
The timestamp, in milliseconds, when the identifier was
|
||||
validated by the identity service.
|
||||
added_at:
|
||||
type: integer
|
||||
format: int64
|
||||
description:
|
||||
The timestamp, in milliseconds, when the homeserver
|
||||
associated the third party identifier with the user.
|
||||
required: ['medium', 'address', 'validated_at', 'added_at']
|
||||
tags:
|
||||
- User data
|
||||
post:
|
||||
|
@ -133,6 +148,41 @@ paths:
|
|||
"$ref": "definitions/errors/error.yaml"
|
||||
tags:
|
||||
- User data
|
||||
"/account/3pid/delete":
|
||||
post:
|
||||
summary: Deletes a third party identifier from the user's account
|
||||
description: |-
|
||||
Removes a third party identifier from the user's account. This might not
|
||||
cause an unbind of the identifier from the identity service.
|
||||
operationId: delete3pidFromAccount
|
||||
security:
|
||||
- accessToken: []
|
||||
parameters:
|
||||
- in: body
|
||||
name: body
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
medium:
|
||||
type: string
|
||||
description: The medium of the third party identifier being removed.
|
||||
enum: ["email", "msisdn"]
|
||||
example: "email"
|
||||
address:
|
||||
type: string
|
||||
description: The third party address being removed.
|
||||
example: "example@domain.com"
|
||||
required: ['medium', 'address']
|
||||
responses:
|
||||
200:
|
||||
description: |-
|
||||
The homeserver has disassociated the third party identifier from the
|
||||
user.
|
||||
schema:
|
||||
type: object
|
||||
properties: {}
|
||||
tags:
|
||||
- User data
|
||||
"/account/3pid/email/requestToken":
|
||||
post:
|
||||
summary: Requests a validation token be sent to the given email address for the purpose of adding an email address to an account
|
||||
|
|
1
changelogs/client_server/newsfragments/1567.feature
Normal file
1
changelogs/client_server/newsfragments/1567.feature
Normal file
|
@ -0,0 +1 @@
|
|||
Document the ``validated_at`` and ``added_at`` fields on ``GET /acount/3pid``.
|
1
changelogs/client_server/newsfragments/1567.new
Normal file
1
changelogs/client_server/newsfragments/1567.new
Normal file
|
@ -0,0 +1 @@
|
|||
Add ``POST /account/3pid/delete``
|
Loading…
Add table
Add a link
Reference in a new issue