LDAPグループリンク

プラン: Premium、Ultimate
提供形態: GitLab Self-Managed

このAPIを使用してLDAPグループリンクを管理します。詳細については、LDAPでのグループメンバーシップの管理を参照してください。

LDAPグループリンクの一覧

LDAPグループリンクをリスト表示します。

GET /groups/:id/ldap_group_links

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`id`	整数または文字列	はい	グループのIDまたはURLエンコードされたパス。

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/4/ldap_group_links"

レスポンス例:

[
  {
    "cn": "group1",
    "group_access": 40,
    "provider": "ldapmain",
    "filter": null,
    "member_role_id": null
  },
  {
    "cn": "group2",
    "group_access": 10,
    "provider": "ldapmain",
    "filter": null,
    "member_role_id": null
  }
]

CNまたはフィルターを使用してLDAPグループリンクを追加

CNまたはフィルターを使用してLDAPグループリンクを追加します。

POST /groups/:id/ldap_group_links

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`id`	整数または文字列	はい	グループのIDまたはURLエンコードされたパス。
`group_access`	整数	はい	LDAPグループのメンバーのロール (`access_level`)。
`provider`	文字列	はい	LDAPグループリンクのLDAPプロバイダーID。
`cn`	文字列	はい/いいえ	LDAPグループのCN。`cn`または`filter`のいずれか一方を指定してください。両方は指定できません。
`filter`	文字列	はい/いいえ	グループのLDAPフィルター。`cn`または`filter`のいずれか一方を指定してください。両方は指定できません。
`member_role_id`	整数	いいえ	メンバーロールのID。Ultimateのみです。

リクエスト例:

curl --request POST \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --data '{"group_access": 40, "provider": "ldapmain", "cn": "group2"}' \
     --url "https://gitlab.example.com/api/v4/groups/4/ldap_group_links"

レスポンス例:

{
  "cn": "group2",
  "group_access": 40,
  "provider": "main",
  "filter": null,
  "member_role_id": null
}

CNまたはフィルターを使用したLDAPグループリンクの削除

CNまたはフィルターを使用してLDAPグループリンクを削除します。

DELETE /groups/:id/ldap_group_links

サポートされている属性は以下のとおりです:

属性	型	必須	説明
`id`	整数または文字列	はい	グループのIDまたはURLエンコードされたパス
`provider`	文字列	はい	LDAPグループリンクのLDAPプロバイダーID。
`cn`	文字列	はい/いいえ	LDAPグループのCN。`cn`または`filter`のいずれか一方を指定してください。両方は指定できません。
`filter`	文字列	はい/いいえ	グループのLDAPフィルター。`cn`または`filter`のいずれか一方を指定してください。両方は指定できません。

リクエスト例:

curl --request DELETE \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --data '{"provider": "ldapmain", "cn": "group2"}' \
     --url "https://gitlab.example.com/api/v4/groups/4/ldap_group_links"

成功した場合、応答は返されません。

LDAPグループリンクの削除（非推奨）

LDAPグループリンクを削除します。非推奨。今後のリリースで削除される予定です。代わりにCNまたはフィルターを使用したLDAPグループリンクの削除を使用してください。

CNを使用してLDAPグループリンクを削除します:

DELETE /groups/:id/ldap_group_links/:cn

属性	型	必須	説明
`id`	整数または文字列	はい	グループのIDまたはURLエンコードされたパス
`cn`	文字列	はい	LDAPグループのCN

特定のLDAPプロバイダーのLDAPグループリンクを削除します:

DELETE /groups/:id/ldap_group_links/:provider/:cn

属性	型	必須	説明
`id`	整数または文字列	はい	グループのIDまたはURLエンコードされたパス
`cn`	文字列	はい	LDAPグループのCN
`provider`	文字列	はい	LDAPグループリンクのLDAPプロバイダー