Commit 4fb0af28 authored by Imran Hussain's avatar Imran Hussain
Browse files

Update README.md to look nicer-ish

parent 08d364c6
Loading
Loading
Loading
Loading
+10 −8
Original line number Diff line number Diff line
@@ -18,15 +18,17 @@ and `callbackpath` are simple, they translate to `<callbackapp>.sucs.org/<callba
### v1


> Simple GET based API to return some json verifying people have logged in
Simple GET based API to return some json verifying people have logged in

> ---
id=<value of `sucs_sso_id_v1` cookie> REQUIRED

> id=<value of `sucs_sso_id_v1` cookie> REQUIRED
> iss=<true|false> OPTIONAL - return if they have logged in using iss creds (default false)
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
> 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