From 4fb0af28ac6f58927b0c10e0460013d01f7c97f7 Mon Sep 17 00:00:00 2001 From: Imran Hussain <imranh@sucs.org> Date: Fri, 24 Jan 2020 11:51:35 +0000 Subject: [PATCH] Update README.md to look nicer-ish --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 05438ab..1450429 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 -- GitLab