Skip to content

Commit 083f615

Browse files
committed
docs: new SSO flow
1 parent 6f13a43 commit 083f615

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/API.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1065,6 +1065,24 @@ curl -XPOST https://shuffler.io/api/v1/orgs/{CURRENT_ORG_ID}/change -H "Authoriz
10651065
{"success": true, "reason": "Changed Organization", "region_url": "New API endpoint IF applicable"}
10661066
```
10671067

1068+
### Generate SSO login link
1069+
If you're using SSO, you can use the above API to also generate login link for your users who aren't already logged in. Please make **sure** to include the "mode" parameter as "login" in the request body.
1070+
1071+
```bash
1072+
curl -XPOST https://shuffler.io/api/v1/orgs/{CURRENT_ORG_ID}/generate_sso_login_link -H "Authorization: Bearer APIKEY" -d '{"org_id": "ORG TO CHANGE TO", "sso":true, "mode": "login"}'
1073+
```
1074+
1075+
Similarly, you can generate a link to allow your user to be connected to your organization as well by using the same request body but removing the "mode" parameter.
1076+
1077+
```bash
1078+
curl -XPOST https://shuffler.io/api/v1/orgs/{CURRENT_ORG_ID}/generate_sso_login_link -H "Authorization: Bearer APIKEY" -d '{"org_id": "ORG TO CHANGE TO", "sso":true}'
1079+
```
1080+
1081+
**Success response**
1082+
```json
1083+
{"success": true, "reason": "SSO_REDIRECT", "url": ""}
1084+
```
1085+
10681086
### Edit Organization
10691087
Edit an Organization. Each field is individually managed, except org_id which is required.
10701088

0 commit comments

Comments
 (0)