authentication

Login user

Logs in a user and creates a session.

post/login

Request

Base URL
https://example-store.com
Auth
none required
TypeScript
https://skmtc.dev/cocartapi/apis/cocart-jwt-authentication/docs/login/post.ts
A function with typed inputs. Its response is checked against the schema.

usernamestring required

Username or email address.

passwordstring required

User password.

User logged in successfully.

user_idstring

Unique ID of the user on the site.

first_namestring

The first name of the user (if any).

last_namestring

The last name of the user (if any).

display_namestring

The display name of the user (if any).

rolestring

The role type assigned to the user.

avatar_urlsobject

The avatar URLs of the user for each avatar size registered.

emailstring

The email address of the user.

extrasobject

Extra details added via the filter.

dev_notestring

A message to developers.

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