Sign in
Logins

Create login

Logins can be of either type device or api.

Logins of type device represent logins from a computer, phone, etc. They contain device information such as device_brand, device_model and os_name. Users can create device logins for themselves when password flow is enabled; for organization owners, password flow is always enabled. Users with an organization-scoped role containing the logins_write permission can create device logins for other users, provided those users do not have greater permissions than the creator. Users can have up to 40 device logins. When the limit is exceeded, the least recently used or oldest login will be removed.

Logins of type api represent logins used by third party applications and integrations. Users can have up to 10 API logins. When the limit is exceeded, creation will fail.

post/logins

Request body

Response

OK

idinteger required

The ID of the login

created_atstring date-time required

When the login was created

updated_atstring date-time required

When the login was updated

type'api' | 'device' required

The type of the login.

namestring nullable required

The name for the login.

primaryboolean required

Whether the login is the primary login.

expireboolean required

Whether the login expires.

last_used_atstring date-time nullable required

When the login was last used.

device_brandstring nullable required

The brand of the device.

device_modelstring nullable required

The model of the device.

os_namestring nullable required

The name of the OS.

user_idinteger required

The user ID of the login

secretstring required

The secret value used for authentication. Returned when creating API logins; Returned for device logins when resolving and creating logins.

authentication_tokenstring required

Alias for secret

has_primary_deviceboolean required

Whether the user has a primary device.

emailstring email required

The email of the user.

notifications_unread_countinteger required

The count of unread notifications.

otp_required_for_loginboolean required

Whether OTP/2FA is required for login.

otp_enabled_atstring date-time nullable required

When was the OTP/2FA enabled.

imagestring uri nullable required

The url to the image of the user.

primary_login_existsboolean required

Whether the user has a primary login.

Changes

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