diff --git a/README.md b/README.md index 05438ab62cdea9e379d5c98c13ff84ecf003fb1b..14504295425b52b96633cac54cdd2c68bd068b91 100644 --- a/README.md +++ b/README.md @@ -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