API групп

API групп позволяет управлять группами пользователей.

Примечание

Для вызова этого API необходимо быть администратором Azure Databricks.

Важно!

Чтобы получить доступ к REST API Databricks, необходимо пройти проверку подлинности.

Добавить участника

Конечная точка Метод HTTP
2.0/groups/add-member POST

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

Примеры

Чтобы добавить пользователя в группу, выполните следующие действия.

curl --netrc -X POST \
https://adb-1234567890123456.7.azuredatabricks.net/api/2.0/groups/add-member \
--data '{ "user_name": "someone@example.com", "parent_name": "reporting-department" }'
{}

Чтобы добавить группу в другую группу, выполните следующие действия.

curl --netrc -X POST \
https://adb-1234567890123456.7.azuredatabricks.net/api/2.0/groups/add-member \
--data '{ "group_name": "reporting-department", "parent_name": "data-ops-read-only" }'
{}

Структура запроса

Имя поля Type Описание
user_name или group_name STRING НИ STRING Если user_name, то имя пользователя.

Если group_name, имя группы.
parent_name STRING Имя родительской группы, в которую будет добавлен новый элемент. Это обязательное поле.

Создание

Конечная точка Метод HTTP
2.0/groups/create POST

Создать новую группу с заданным именем. Этот вызов возвращает ошибку, RESOURCE_ALREADY_EXISTS Если группа с данным именем уже существует.

Пример

curl --netrc -X POST \
https://adb-1234567890123456.7.azuredatabricks.net/api/2.0/groups/create \
--data '{ "group_name": "reporting-department" }'
{ "group_name": "reporting-department" }

Структура запроса

Имя поля Type Описание
group_name STRING Имя группы; должно быть уникальным в группах, принадлежащих этой Организации. Это обязательное поле.

Структура ответа

Имя поля Type Описание
group_name STRING Имя группы.

Список членов

Конечная точка Метод HTTP
2.0/groups/list-members GET

Возвращает всех членов определенной группы. Этот вызов возвращает ошибку, RESOURCE_DOES_NOT_EXIST Если группа с данным именем не существует. Этот метод не является рекурсивным; Он возвращает все группы, принадлежащие к данной группе, но не субъекты, принадлежащие этим дочерним группам.

Пример

curl --netrc -X GET \
https://adb-1234567890123456.7.azuredatabricks.net/api/2.0/groups/list-members \
--data '{ "group_name": "reporting-department" }' \
| jq .
{
  "members": [
    {
      "user_name": "someone@example.com"
    }
  ]
}

Структура запроса

Имя поля Type Описание
group_name STRING Группа, члены которой необходимо извлечь. Это обязательное поле.

Структура ответа

Имя поля Type Описание
members Массив PrincipalName Пользователи и группы, принадлежащие к данной группе.

Список

Конечная точка Метод HTTP
2.0/groups/list GET

Возврат всех групп в Организации.

Пример

curl --netrc -X GET \
https://adb-1234567890123456.7.azuredatabricks.net/api/2.0/groups/list \
| jq .
{
  "group_names": [
    "reporting-department",
    "data-ops-read-only",
    "admins"
  ]
}

Структура ответа

Имя поля Type Описание
group_names Массив объектов STRING. Группы в этой Организации.

Список родителей

Конечная точка Метод HTTP
2.0/groups/list-parents GET

Получение всех групп, членом которых является данный пользователь или группа. Этот метод не является рекурсивным; Он возвращает все группы, членом которых является данный пользователь или группа, но не группы, в которых эти группы являются членами. Этот вызов возвращает ошибку, RESOURCE_DOES_NOT_EXIST Если пользователь или группа с данным именем не существует.

Примеры

Чтобы вывести список групп для пользователя, сделайте следующее:

curl --netrc -X GET \
https://adb-1234567890123456.7.azuredatabricks.net/api/2.0/groups/list-parents \
--data '{ "user_name": "someone@example.com" }' \
| jq .
{
  "group_names": [
    "reporting-department"
  ]
}

Чтобы получить список родительских групп для группы, сделайте следующее:

curl --netrc -X GET \
https://adb-1234567890123456.7.azuredatabricks.net/api/2.0/groups/list-parents \
--data '{ "group_name": "reporting-department" }' \
| jq .
{
  "group_names": [
    "data-ops-read-only"
  ]
}

Структура запроса

Имя поля Type Описание
user_name или group_name STRING НИ STRING Если user_name, то имя пользователя.

Если group_name, имя группы.

Структура ответа

Имя поля Type Описание
group_names Массив объектов STRING. Группы, в которые входит данный пользователь или группа.

Удалить участника

Конечная точка Метод HTTP
2.0/groups/remove-member POST

Удаление пользователя или группы из группы. Этот вызов возвращает ошибку, RESOURCE_DOES_NOT_EXIST Если пользователь или группа с данным именем не существует или если группа с указанным родительским именем не существует.

Примеры

Чтобы удалить пользователя из группы, выполните следующие действия.

curl --netrc -X POST \
https://adb-1234567890123456.7.azuredatabricks.net/api/2.0/groups/remove-member \
--data '{ "user_name": "someone@example.com", "parent_name": "reporting-department" }'
{}

Чтобы удалить группу из другой группы, выполните следующие действия.

curl --netrc -X POST \
https://adb-1234567890123456.7.azuredatabricks.net/api/2.0/groups/remove-member \
--data '{ "group_name": "reporting-department", "parent_name": "data-ops-read-only" }'
{}

Структура запроса

Имя поля Type Описание
user_name или group_name STRING НИ STRING Если user_name, то имя пользователя.

Если group_name, имя группы.
parent_name STRING Имя родительской группы, из которой будет удален элемент. Это обязательное поле.

Удаление

Конечная точка Метод HTTP
2.0/groups/delete POST

Удаление группы из этой Организации. Этот вызов возвращает ошибку, RESOURCE_DOES_NOT_EXIST Если группа с данным именем не существует.

Пример

curl --netrc -X POST \
https://adb-1234567890123456.7.azuredatabricks.net/api/2.0/groups/delete \
--data '{ "group_name": "reporting-department" }'
{}

Структура запроса

Имя поля Type Описание
group_name STRING Удаляемая группа. Это обязательное поле.

Структуры данных

В этом разделе рассматриваются следующие вопросы.

PrincipalName

Тип контейнера для имени, которое является либо именем пользователя, либо именем группы.

Имя поля Type Описание
user_name или group_name STRING НИ STRING Если user_name, то имя пользователя.

Если group_name, имя группы.