RegisterResponse
Defined in: src/@types/registration.ts:69
The result of a successful call to POST /_matrix/client/v3/register.
https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv3register
Properties
Section titled “Properties”access_token?
Section titled “access_token?”
optionalaccess_token?:string
Defined in: src/@types/registration.ts:79
An access token for the account. This access token can then be used to authorize other requests. Required if the inhibit_login option is false.
device_id?
Section titled “device_id?”
optionaldevice_id?:string
Defined in: src/@types/registration.ts:85
ID of the registered device. Will be the same as the corresponding parameter in the request, if one was specified. Required if the inhibit_login option is false.
expires_in_ms?
Section titled “expires_in_ms?”
optionalexpires_in_ms?:number
Defined in: src/@types/registration.ts:94
The lifetime of the access token, in milliseconds. Once the access token has expired a new access token can be obtained by using the provided refresh token. If no refresh token is provided, the client will need to re-log in to obtain a new access token. If not given, the client can assume that the access token will not expire.
Omitted if the inhibit_login option is true.
refresh_token?
Section titled “refresh_token?”
optionalrefresh_token?:string
Defined in: src/@types/registration.ts:101
A refresh token for the account. This token can be used to obtain a new access token when it expires by calling the /refresh endpoint.
Omitted if the inhibit_login option is true.
user_id
Section titled “user_id”user_id:
string
Defined in: src/@types/registration.ts:73
The fully-qualified Digital World user ID (MXID) that has been registered.