tocdepth: 2

Управление сервисными аккаунтами

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

Перед началом работы

Для работы с API потребуется:

эндпоинт для запросов — https://iam.api.cloud.ru/api/v1;
авторизационный токен;
сервисный аккаунт.

Набор методов для управления сервисными аккаунтами

POST /api/v1/service-accounts

Добавление нового сервисного аккаунта.

Request JSON Object

description (string) – Описание.
name (string) – Название сервисного аккаунта.
projectId (string) – Идентификатор ресурса типа project, для которого добавляется сервисный аккаунт.

Status Codes

200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
409 Conflict – Конфликт.
500 Internal Server Error – Внутренняя ошибка сервера.

Response JSON Object

serviceAccount (object) – Информация о сервисном аккаунте.
serviceAccount.createdAt (string) – Дата создания записи.
serviceAccount.description (string) – Описание.
serviceAccount.email (string) – Электронная почта сервисного аккаунта.
serviceAccount.enabled (boolean) – Включен или выключен сервисный аккаунт.
serviceAccount.id (string) – Идентификатор сервисного аккаунта.
serviceAccount.name (string) – Название сервисного аккаунта. Уникально для namespace_id.
serviceAccount.namespaceId (string) – Область видимости.
serviceAccount.updatedAt (string) – Дата обновления записи.
serviceAccount.useRefreshTokens (boolean) – Выпускать обновления токена или нет (по умолчанию false).

POST /api/v1/service-accounts/credentials/access-keys

Добавление ключа доступа сервисному аккаунту.

Request JSON Object

description (string) – Описание.
serviceAccountId (string) – Идентификатор сервисного аккаунта.
ttl (string) – h - часы, m - минуты, s - секунды.

Status Codes

200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
500 Internal Server Error – Внутренняя ошибка сервера.

Response JSON Object

createdAt (string) – Дата создания записи.
description (string) – Описание.
expiredAt (string) – Дата окончания действия ключа.
id (string) – IИдентификатор ключа.
keyId (string) – Секретный ключ.
secret (string) – Секретный ключ.
serviceAccountId (string) – Идентификатор сервисного аккаунта.

GET /api/v1/service-accounts/credentials/access-keys/{id}

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

Parameters

id (string) – Идентификатор ключа.

Status Codes

200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
500 Internal Server Error – Внутренняя ошибка сервера.

Response JSON Object

key (object) – Ключ доступа без секрета.
key.createdAt (string) – Дата создания записи.
key.description (string) – Описание.
key.expiredAt (string) – Дата окончания действия ключа.
key.id (string) – Идентификатор ключа.
key.keyId (string) – Секретный ключ.
key.serviceAccountId (string) – Идентификатор сервисного аккаунта.

DELETE /api/v1/service-accounts/credentials/access-keys/{id}

Удаление ключа доступа по идентификатору для сервисного аккаунта.

Parameters

id (string) – Идентификатор ключа.

Status Codes

200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
500 Internal Server Error – Внутренняя ошибка сервера.

GET /api/v1/service-accounts/{serviceAccountId}

Просмотр информации о сервисном аккаунте.

Parameters

serviceAccountId (string) – Идентификатор сервисного аккаунта.

Status Codes

200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
500 Internal Server Error – Внутренняя ошибка сервера.

Response JSON Object

serviceAccount (object) – Информация о сервисном аккаунте.
serviceAccount.createdAt (string) – Дата создания записи.
serviceAccount.description (string) – Описание.
serviceAccount.email (string) – Электронная почта сервисного аккаунта.
serviceAccount.enabled (boolean) – Включен или выключен сервисный аккаунт.
serviceAccount.id (string) – Идентификатор сервисного аккаунта.
serviceAccount.name (string) – Название сервисного аккаунта. Уникально для namespace_id.
serviceAccount.namespaceId (string) – Область видимости.
serviceAccount.updatedAt (string) – Дата обновления записи.
serviceAccount.useRefreshTokens (boolean) – Выпускать обновления токена или нет (по умолчанию false).

DELETE /api/v1/service-accounts/{serviceAccountId}

Удаление сервисныйого аккаунта.

Parameters

serviceAccountId (string) – Идентификатор сервисного аккаунта.

Status Codes

200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
409 Conflict – Конфликт.
500 Internal Server Error – Внутренняя ошибка сервера.

GET /api/v1/service-accounts/{serviceAccountId}/credentials/access-keys

Просмотр списка ключей доступа для сервисного аккаунта.

Parameters

serviceAccountId (string) – Идентификатор сервисного аккаунта.

Status Codes

200 OK – Успешное выполнение запроса.
400 Bad Request – Некорректный запрос.
401 Unauthorized – Необходима авторизация.
403 Forbidden – Доступ запрещен.
404 Not Found – Ресурс не найден.
500 Internal Server Error – Внутренняя ошибка сервера.

Response JSON Object

accessKeys (array) – Список ключей доступа.
accessKeys[].createdAt (string) – Дата создания записи.
accessKeys[].description (string) – Описание.
accessKeys[].expiredAt (string) – Дата окончания действия ключа.
accessKeys[].id (string) – Идентификатор ключа.
accessKeys[].keyId (string) – Секретный ключ.
accessKeys[].serviceAccountId (string) – Идентификатор сервисного аккаунта.

Была ли статья полезной?