Interface LoginRequest

Request body for POST /login request

See

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

interface LoginRequest {
    device_id?: string;
    identifier?: UserIdentifier;
    initial_device_display_name?: string;
    medium?: "email";
    password?: string;
    refresh_token?: boolean;
    token?: string;
    type: string;
    user?: string;
    [key: string]: any;
}

Indexable

  • [key: string]: any

Properties

device_id? identifier? initial_device_display_name? medium? password? refresh_token? token? type user?

Properties

Optionaldevice_id

device_id?: string

ID of the client device. If this does not correspond to a known client device, a new device will be created. The given device ID must not be the same as a cross-signing key ID. The server will auto-generate a device_id if this is not specified.

Optionalidentifier

identifier?: UserIdentifier

Identification information for a user

Optionalinitial_device_display_name

initial_device_display_name?: string

A display name to assign to the newly-created device. Ignored if device_id corresponds to a known device.

Optionalmedium

medium

When logging in using a third-party identifier, the medium of the identifier. Must be email.

Deprecated

in favour of identifier.

Optionalpassword

password?: string

Required when type is m.login.password. The user’s password.

Optionalrefresh_token

refresh_token?: boolean

If true, the client supports refresh tokens.

Optionaltoken

token?: string

Required when type is m.login.token. Part of Token-based login.

type

type: string

The login type being used.

Optionaluser

user?: string

The fully qualified user ID or just local part of the user ID, to log in.

Deprecated

in favour of identifier.

Settings

Member Visibility

On This Page

Properties