Download the PHP package polaris/username without Composer
On this page you can find all versions of the php package polaris/username. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download polaris/username
More information about polaris/username
Files in polaris/username
Package username
Short Description Username for Polaris for PHP: sign in with a username or an email through core's password path, case-insensitive unique usernames with a display form, validation rules from configuration
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package username
polaris/username
Usernames for Polaris for PHP: a user picks a username, unique without regard to case, and signs in with it or with the email through core's own password path, so lockout, the email-verification rule, the MFA gate and the envelope are core's.
In Laravel, Symfony and Yii the instance goes in the adapter's plugins configuration; the table
(polaris_username) joins polaris:install, schema:create and schema:diff, the routes join the route
table. Core's /auth/login is untouched.
Routes
| Route | Who | Does |
|---|---|---|
PATCH /username {username, display_username?} |
bearer | sets or changes the caller's username |
POST /username/sign-in {username, password} |
public, rate limit login |
username is a username (any case) or an email; answers core's login envelope, or its mfa_required ticket to complete at /auth/mfa/verify |
A username is stored lowercased (the unique column) beside the form the user typed
(display_username, the same letters in another case), so Ada.Lovelace and ada.lovelace are one
name on PostgreSQL, MySQL and SQLite alike, without collations; the unique index settles two users taking
the same name at once.
An unknown username, a wrong password and a live lockout answer the same
401 username/invalid_credentials, and an unknown username costs the same password check as an unknown
email. Other errors: 403 username/email_unverified, 403 username/account_disabled,
422 username/invalid_input, 422 username/invalid (with errors), 409 username/taken. The TypeScript
client has both routes as client.username.*.
Rules
Sentinel
With polaris/sentinel, add the sign-in route to sentinel's guarded list:
License
MIT. Polaris for PHP is created and maintained by 2am.tech.
