Commit 2817cf12 authored by Cynthia Ng's avatar Cynthia Ng Committed by Evan Read

Docs: Add group saml identity API response info

parent 12ac49bf
...@@ -45,7 +45,8 @@ Example response: ...@@ -45,7 +45,8 @@ Example response:
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
"web_url": "http://192.168.1.8:3000/root", "web_url": "http://192.168.1.8:3000/root",
"expires_at": "2012-10-22T14:13:35Z", "expires_at": "2012-10-22T14:13:35Z",
"access_level": 30 "access_level": 30,
"group_saml_identity": null
}, },
{ {
"id": 2, "id": 2,
...@@ -55,7 +56,12 @@ Example response: ...@@ -55,7 +56,12 @@ Example response:
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
"web_url": "http://192.168.1.8:3000/root", "web_url": "http://192.168.1.8:3000/root",
"expires_at": "2012-10-22T14:13:35Z", "expires_at": "2012-10-22T14:13:35Z",
"access_level": 30 "access_level": 30,
"group_saml_identity": {
"extern_uid":"ABC-1234567890",
"provider": "group_saml",
"saml_provider_id": 10
}
} }
] ]
``` ```
...@@ -94,7 +100,8 @@ Example response: ...@@ -94,7 +100,8 @@ Example response:
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
"web_url": "http://192.168.1.8:3000/root", "web_url": "http://192.168.1.8:3000/root",
"expires_at": "2012-10-22T14:13:35Z", "expires_at": "2012-10-22T14:13:35Z",
"access_level": 30 "access_level": 30,
"group_saml_identity": null
}, },
{ {
"id": 2, "id": 2,
...@@ -105,6 +112,11 @@ Example response: ...@@ -105,6 +112,11 @@ Example response:
"web_url": "http://192.168.1.8:3000/root", "web_url": "http://192.168.1.8:3000/root",
"expires_at": "2012-10-22T14:13:35Z", "expires_at": "2012-10-22T14:13:35Z",
"access_level": 30 "access_level": 30
"group_saml_identity": {
"extern_uid":"ABC-1234567890",
"provider": "group_saml",
"saml_provider_id": 10
}
}, },
{ {
"id": 3, "id": 3,
...@@ -114,7 +126,8 @@ Example response: ...@@ -114,7 +126,8 @@ Example response:
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
"web_url": "http://192.168.1.8:3000/root", "web_url": "http://192.168.1.8:3000/root",
"expires_at": "2012-11-22T14:13:35Z", "expires_at": "2012-11-22T14:13:35Z",
"access_level": 30 "access_level": 30,
"group_saml_identity": null
} }
] ]
``` ```
...@@ -149,7 +162,8 @@ Example response: ...@@ -149,7 +162,8 @@ Example response:
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
"web_url": "http://192.168.1.8:3000/root", "web_url": "http://192.168.1.8:3000/root",
"access_level": 30, "access_level": 30,
"expires_at": null "expires_at": null,
"group_saml_identity": null
} }
``` ```
...@@ -185,7 +199,8 @@ Example response: ...@@ -185,7 +199,8 @@ Example response:
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
"web_url": "http://192.168.1.8:3000/root", "web_url": "http://192.168.1.8:3000/root",
"access_level": 30, "access_level": 30,
"expires_at": null "expires_at": null,
"group_saml_identity": null
} }
``` ```
...@@ -221,7 +236,8 @@ Example response: ...@@ -221,7 +236,8 @@ Example response:
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
"web_url": "http://192.168.1.8:3000/root", "web_url": "http://192.168.1.8:3000/root",
"expires_at": "2012-10-22T14:13:35Z", "expires_at": "2012-10-22T14:13:35Z",
"access_level": 30 "access_level": 30,
"group_saml_identity": null
} }
``` ```
...@@ -257,7 +273,8 @@ Example response: ...@@ -257,7 +273,8 @@ Example response:
"avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon",
"web_url": "http://192.168.1.8:3000/root", "web_url": "http://192.168.1.8:3000/root",
"expires_at": "2012-10-22T14:13:35Z", "expires_at": "2012-10-22T14:13:35Z",
"access_level": 40 "access_level": 40,
"group_saml_identity": null
} }
``` ```
......
...@@ -295,6 +295,8 @@ For convenience, we've included some [example resources](../../../administration ...@@ -295,6 +295,8 @@ For convenience, we've included some [example resources](../../../administration
In troubleshooting the Group SAML setup, any authenticated user can use the API to verify the NameID GitLab already has linked to the user by visiting [https://gitlab.com/api/v4/user](https://gitlab.com/api/v4/user) and checking the `extern_uid` under identities. In troubleshooting the Group SAML setup, any authenticated user can use the API to verify the NameID GitLab already has linked to the user by visiting [https://gitlab.com/api/v4/user](https://gitlab.com/api/v4/user) and checking the `extern_uid` under identities.
Similarly, group members of a role with the appropriate permissions can make use of the [members API](../../../api/members.md) to view group SAML identity information for members of the group.
This can then be compared to the [NameID](#nameid) being sent by the Identity Provider by decoding the message with a [SAML debugging tool](#saml-debugging-tools). We require that these match in order to identify users. This can then be compared to the [NameID](#nameid) being sent by the Identity Provider by decoding the message with a [SAML debugging tool](#saml-debugging-tools). We require that these match in order to identify users.
### Message: "SAML authentication failed: Extern uid has already been taken" ### Message: "SAML authentication failed: Extern uid has already been taken"
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment