Commit a1181ec1 authored by Imran Hussain's avatar Imran Hussain
Browse files

Add a README

parent ddf9bfc0
# SUCS Single Sign On
## Core
The core of the Application `public/index.php` allows people to verify their
sucs and iss accounts with us.
## API
### v1
> Simple GET based API to return some json verifying people have logged in
> ---
> id=<value of `sucs_sso_id_v1` cookie> REQUIRED
> iss=<true|false> OPTIONAL - return if they have logged in using iss creds (default false)
> ---
> apistate - should always be "ok" if not then don't trust the result
> sucs_username - will be their username
> iss_username - will be their iss username, only if requested
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment