matrix-spec/api/client-server/definitions/auth_data.yaml
Richard van der Hoff 9efd021f5e Document the user-interactive api params
Document the parameters and responses on /register and /account/password which
are invoved in the user-interactive auth
2016-05-06 16:47:49 +01:00

21 lines
564 B
YAML

title: Authentication Data
description: |-
Used by clients to submit authentication information to the interactive-authentication API
type: object
properties:
type:
description: The login type that the client is attempting to complete.
type: string
session:
description: The value of the session key given by the homeserver.
type: string
additionalProperties:
description: Keys dependent on the login type
type: object
required:
- type
example:
type: "example.type.foo"
session: "xxxxx"
example_credential: "verypoorsharedsecret"