Download the PHP package axolote-source/authxolote-sdk without Composer
On this page you can find all versions of the php package axolote-source/authxolote-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package authxolote-sdk
Authxolote SDK
Authxolote SDK is a Laravel library designed to seamlessly integrate your application with the Authxolote authentication and authorization service.
Installation
You can install the package via composer:
The service provider will automatically register itself.
Configuration
Publish the configuration file using the following command:
This will create a config/authxolote.php file where you can configure:
url: The Authxolote API base URL.token: Your application's authentication token.cache: Enable or disable caching for user data.sync_user: Whether to look up users in your local database or use API data directly.
Translations
If you want to customize the SDK messages, you can publish the translation files:
This will copy the JSON translation files to lang/vendor/authxolote, where you can modify the strings for different languages.
You can also use environment variables in your .env file:
Setup Authentication
To use the Authxolote guard, add it to your config/auth.php:
Usage
Authentication
Once configured, you can use the authxolote guard in your routes or controllers:
Checking Permissions
You can easily check for permissions using the Authxolote facade:
User Registration
Register new users directly through the SDK:
Console Commands
To synchronize roles and actions, you must first create a config/actions.php file and register the roles with their respective actions:
Then, synchronize the roles and actions defined in your configuration:
Testing
The SDK provides a built-in fake mode to facilitate unit testing without making actual API calls:
Middleware
The SDK includes a middleware to protect your routes based on permissions. It is automatically registered as isAllow.
Basic Usage
You can use it in your routes:
Controller Groups Example
It is recommended to use a naming convention like project.module.action for your permissions. Here is an example using a controller group:
If the user does not have permission, the middleware will:
- Return a JSON response with status 403 if the request expects JSON.
- Throw a 403 HTTP exception otherwise.
To use this middleware, your User model (or the object returned by the guard) must use the Authxolote\Sdk\Traits\HasActions trait.
Credits
License
The MIT License (MIT). Please see License File for more information.
All versions of authxolote-sdk with dependencies
illuminate/support Version ^10.0|^11.0|^12.0
spatie/laravel-data Version ^3.0|^4.0