Sign in
stages

UserLoginStage Viewset

post/stages/user_login/

Request body

namestring required
session_durationstring

Determines how long a session lasts. Default of 0 means that the sessions lasts until the browser is closed. (Format: hours=-1;minutes=-2;seconds=-3)

terminate_other_sessionsboolean

Terminate all other sessions of the user logging in.

remember_me_offsetstring

Offset the session will be extended by when the user picks the remember me option. Default of 0 means that the remember me option will not be shown. (Format: hours=-1;minutes=-2;seconds=-3)

network_binding'no_binding' | 'bind_asn' | 'bind_asn_network' | 'bind_asn_network_ip'
geoip_binding'no_binding' | 'bind_continent' | 'bind_continent_country' | 'bind_continent_country_city'
remember_devicestring

When set to a non-zero value, authentik will save a cookie with a longer expiry,to remember the device the user is logging in from. (Format: hours=-1;minutes=-2;seconds=-3)

Response

pkstring uuid required
namestring required
componentstring required

Get object type so that we know how to edit the object

verbose_namestring required

Return object's verbose_name

verbose_name_pluralstring required

Return object's plural verbose_name

meta_model_namestring required

Return internal model name

session_durationstring

Determines how long a session lasts. Default of 0 means that the sessions lasts until the browser is closed. (Format: hours=-1;minutes=-2;seconds=-3)

terminate_other_sessionsboolean

Terminate all other sessions of the user logging in.

remember_me_offsetstring

Offset the session will be extended by when the user picks the remember me option. Default of 0 means that the remember me option will not be shown. (Format: hours=-1;minutes=-2;seconds=-3)

network_binding'no_binding' | 'bind_asn' | 'bind_asn_network' | 'bind_asn_network_ip'
geoip_binding'no_binding' | 'bind_continent' | 'bind_continent_country' | 'bind_continent_country_city'
remember_devicestring

When set to a non-zero value, authentik will save a cookie with a longer expiry,to remember the device the user is logging in from. (Format: hours=-1;minutes=-2;seconds=-3)

Changes

No recorded changes to this endpoint across all 1 revision of this API.