Для улучшения работы сайта мы используем файлы cookies. Оставаясь на сайте, вы соглашаетесь с политикой обработки персональных данных.

Group Alias

В данном разделе представлена документация API для управления псевдонимами групп в хранилище идентификации.

1. Создание псевдонима группы

Эта конечная точка создает или обновляет псевдоним группы.

Метод Путь

POST

/identity/group-alias

1.1. Параметры

  • name (string: entity-<UUID>) - имя псевдонима группы.

  • id (string: <необязательно>) - ID псевдонима группы. Если установлен, обновляет соответствующий существующий псевдоним группы.

  • mount_accessor (string: "") - accessor монтирования, к которому принадлежит этот псевдоним.

  • canonical_id (string: "") - ID группы, к которой принадлежит этот псевдоним.

Пример тела запроса:
{
  "canonical_id": "b86920ea-2831-00ff-15c5-a3f923f1ee3b",
  "mount_accessor": "auth_ldap_2f5a71b9",
  "name": "dev-team"
}
Пример запроса:
$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    http://127.0.0.1:8200/v1/identity/group-alias
Пример ответа:
{
  "data": {
    "canonical_id": "b86920ea-2831-00ff-15c5-a3f923f1ee3b",
    "id": "ca726050-d8ac-6f1f-4210-3b5c5b613824"
  }
}

2. Обновление псевдонима группы по ID

Эта конечная точка используется для обновления существующего псевдонима группы.

Метод Путь

POST

/identity/group-alias/id/:id

2.1. Параметры

  • id (string: <необязательно>) - ID псевдонима группы;

  • name (string: entity-<UUID>) - имя псевдонима группы;

  • mount_accessor (string: "") - accessor монтирования, к которому принадлежит этот псевдоним;

  • canonical_id (string: "") - ID группы, к которой принадлежит этот псевдоним.

Пример тела запроса:
{
  "canonical_id": "b86920ea-2831-00ff-15c5-a3f923f1ee3b",
  "mount_accessor": "auth_ldap_2f5a71b9",
  "name": "dev-team2"
}
Пример запроса:
$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    http://127.0.0.1:8200/v1/identity/group-alias/id/ca726050-d8ac-6f1f-4210-3b5c5b613824
Пример ответа:
{
  "data": {
    "canonical_id": "b86920ea-2831-00ff-15c5-a3f923f1ee3b",
    "id": "ca726050-d8ac-6f1f-4210-3b5c5b613824"
  }
}

3. Чтение псевдонима группы по ID

Эта конечная точка запрашивает псевдоним группы по его идентификатору.

Метод Путь

GET

/identity/group-alias/id/:id

3.1. Параметры

  • id (string: <обязательно>) - ID псевдонима группы.

Пример запроса:
$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/identity/group-alias/id/ca726050-d8ac-6f1f-4210-3b5c5b613824
Пример ответа:
{
  "data": {
    "canonical_id": "b86920ea-2831-00ff-15c5-a3f923f1ee3b",
    "creation_time": "2025-07-29T11:45:48.855700956Z",
    "id": "ca726050-d8ac-6f1f-4210-3b5c5b613824",
    "last_update_time": "2025-07-29T11:48:37.246860748Z",
    "merged_from_canonical_ids": null,
    "metadata": null,
    "mount_accessor": "auth_ldap_2f5a71b9",
    "mount_path": "",
    "mount_type": "ldap",
    "name": "dev-team2"
  }
}

4. Удаление псевдонима группы по ID

Эта конечная точка удаляет псевдоним группы.

Метод Путь

DELETE

/identity/group-alias/id/:id

4.1. Параметры

  • id (string: <обязательно>) - ID псевдонима группы.

Пример запроса:
$ curl \
    --header "X-Vault-Token: ..." \
    --request DELETE \
    http://127.0.0.1:8200/v1/identity/group-alias/id/ca726050-d8ac-6f1f-4210-3b5c5b613824

5. Список псевдонимов групп по ID

Эта конечная точка возвращает список доступных псевдонимов групп по их идентификаторам.

Метод Путь

LIST

/identity/group-alias/id

GET

/identity/group-alias/id?list=true
Пример запроса:
$ curl \
    --header "X-Vault-Token: ..." \
    --request LIST \
    http://127.0.0.1:8200/v1/identity/group-alias/id
Пример ответа:
{
  "data": {
    "keys": ["ca726050-d8ac-6f1f-4210-3b5c5b613824"]
  }
}