nitroxy / nxauth
There is no license information available for the latest version (v1.1) of this package.
A module for authenticating with NitroXys CAS-service
v1.1
2016-07-11 14:37 UTC
Requires
- jasig/phpcas: ^1.3
This package is auto-updated.
Last update: 2024-12-11 20:02:13 UTC
README
This code provide a API for nitroxy.com. On a basic level it provides cas login, giving you only username and name of the user, but with a API key you can gain access to much more.
Usage
Put this as a submodule in your repository, then copy nxauth.sample.php into your project and modify it.
Functions
NXAuth
These functions does not require a API key
- NXAuth::login(): Trigger login
- NXAuth::logout(): Trigger logout
- NXAuth::is_authenticated(): bool
- NXAuth::user(): Return a NXUser instance with the current user, or null
NXUser
These functions does not require a API key
Contains these attributes:
- username
- user_id
- fullname
- ticket
NXAPI
NXAPI::api_function_name(api_options) calls api_function_name with api_options.