Interface LoginWithCredentialsRequest

interface LoginWithCredentialsRequest {
    captcha_ref?: string;
    dc?: string;
    device_fp?: string;
    field_key?: string;
    locale?: string;
    password: string;
    provider?: string;
    remember_me?: boolean;
    requestId: string;
    username: string;
    username_type?: UsernameType;
}

Properties

captcha_ref? dc? device_fp? field_key? locale? password provider? remember_me? requestId username username_type?

Properties

Optionalcaptcha_ref

captcha_ref?: string

Id of captcha created in cidaas admin ui

Optionaldc

dc?: string

Device capacity

Optionaldevice_fp

device_fp?: string

Device finger print

Optionalfield_key

field_key?: string

Field identifier to tell service, where to look for in case of custom username type

Optionallocale

locale?: string

Response language, which is configured in cidaas admin ui

password

password: string

Password required to login

Optionalprovider

provider?: string

Login provider configured in cidaas admin ui

Optionalremember_me

remember_me?: boolean

Remember me flag to keep user signed in

requestId

requestId: string

Request id returned from the authorization call

username

username: string

User identifier used to login e.g. username, email or mobile number

Optionalusername_type

username_type?: UsernameType

Type of username used in login

Settings

Member Visibility

On This Page

Properties