IAuthData
Defined in: src/interactive-auth.ts:52
Data returned in the body of a 401 response from a UIA endpoint.
https://spec.matrix.org/v1.6/client-server-api/#user-interactive-api-in-the-rest-api
Properties
Section titled “Properties”completed?
Section titled “completed?”
optionalcompleted?:string[]
Defined in: src/interactive-auth.ts:61
A list of the stages the client has completed successfully
flows?
Section titled “flows?”
optionalflows?:UIAFlow[]
Defined in: src/interactive-auth.ts:65
A list of the login flows supported by the server for this API.
params?
Section titled “params?”
optionalparams?:Record<string,Record<string,any>>
Defined in: src/interactive-auth.ts:71
Contains any information that the client will need to know in order to use a given type of authentication. For each login type presented, that type may be present as a key in this dictionary. For example, the public part of an OAuth client ID could be given here.
session?
Section titled “session?”
optionalsession?:string
Defined in: src/interactive-auth.ts:57
This is a session identifier that the client must pass back to the home server, if one is provided, in subsequent attempts to authenticate in the same API call.