Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/saml.md')
-rw-r--r--doc/api/saml.md78
1 files changed, 78 insertions, 0 deletions
diff --git a/doc/api/saml.md b/doc/api/saml.md
new file mode 100644
index 00000000000..810ed382d49
--- /dev/null
+++ b/doc/api/saml.md
@@ -0,0 +1,78 @@
+---
+stage: Manage
+group: Authentication and Authorization
+info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
+---
+
+# SAML API **(PREMIUM SAAS)**
+
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227841) in GitLab 15.5.
+
+API for accessing SAML features.
+
+## Get SAML identities for a group
+
+```plaintext
+GET /groups/:id/saml/identities
+```
+
+Fetch SAML identities for a group.
+
+Supported attributes:
+
+| Attribute | Type | Required | Description |
+|:------------------|:--------|:---------|:----------------------|
+| `id` | integer | Yes | Group ID for the group to return SAML identities. |
+
+If successful, returns [`200`](index.md#status-codes) and the following
+response attributes:
+
+| Attribute | Type | Description |
+| ------------ | ------ | ------------------------- |
+| `extern_uid` | string | External UID for the user |
+| `user_id` | string | ID for the user |
+
+Example request:
+
+```shell
+curl --location --request GET "https://gdk.test:3443/api/v4/groups/33/saml/identities" \
+--header "<PRIVATE-TOKEN>" \
+--form "extern_uid=<ID_TO_BE_UPDATED>" \
+```
+
+Example response:
+
+```json
+[
+ {
+ "extern_uid": "4",
+ "user_id": 48
+ }
+]
+```
+
+## Update `extern_uid` field for a SAML identity
+
+Update `extern_uid` field for a SAML identity. Field that can be updated are:
+
+| SAML IdP attribute | GitLab field |
+| ------------------ | ------------ |
+| `id/externalId` | `extern_uid` |
+
+```plaintext
+PATCH groups/:groups_id/saml/:uid
+```
+
+Parameters:
+
+| Attribute | Type | Required | Description |
+| --------- | ------ | -------- | ------------------------- |
+| `uid` | string | yes | External UID of the user. |
+
+Example request:
+
+```shell
+curl --location --request PATCH "https://gdk.test:3443/api/v4/groups/33/saml/sydney_jones" \
+--header "<PRIVATE TOKEN>" \
+--form "extern_uid=sydney_jones_new" \
+```