matrix-js-sdk

    Interface RegisterResponse

    The result of a successful call to POST /_matrix/client/v3/register.

    https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv3register

    interface RegisterResponse {
        access_token?: string;
        device_id?: string;
        expires_in_ms?: number;
        refresh_token?: string;
        user_id: string;
    }
    Index

    Properties

    access_token? device_id? expires_in_ms? refresh_token? user_id

    Properties

    access_token?: string

    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?: string

    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?: number

    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?: string

    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: string

    The fully-qualified Matrix user ID (MXID) that has been registered.

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR