summaryrefslogtreecommitdiff
path: root/doc/user/admin_area/settings/external_authorization.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/user/admin_area/settings/external_authorization.md')
-rw-r--r--doc/user/admin_area/settings/external_authorization.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/user/admin_area/settings/external_authorization.md b/doc/user/admin_area/settings/external_authorization.md
index 11c0867da17..c1aa04f7bc2 100644
--- a/doc/user/admin_area/settings/external_authorization.md
+++ b/doc/user/admin_area/settings/external_authorization.md
@@ -76,13 +76,19 @@ service with this body:
{
"user_identifier": "jane@acme.org",
"project_classification_label": "project-label",
- "user_ldap_dn": "CN=Jane Doe,CN=admin,DC=acme"
+ "user_ldap_dn": "CN=Jane Doe,CN=admin,DC=acme",
+ "identities": [
+ { "provider": "ldap", "extern_uid": "CN=Jane Doe,CN=admin,DC=acme" },
+ { "provider": "bitbucket", "extern_uid": "2435223452345" }
+ ]
}
```
The `user_ldap_dn` is optional and is only sent when the user is logged in
through LDAP.
+`identities` will contain the details of all the identities associated with the user. This will be an empty array if there are no identities associated with the user.
+
When the external authorization service responds with a status code 200, the
user is granted access. When the external service responds with a status code
401 or 403, the user is denied access. In any case, the request is cached for 6 hours.