Подключиться
Yandex Identity and Access Management

ServiceAccountService

Набор методов для управления ресурсами ServiceAccount.

Вызов Описание
Get Возвращает указанный ресурс ServiceAccount.
List Возвращает список доступных ресурсов ServiceAccount в указанном каталоге.
Create Создает сервисный аккаунт в указанном каталоге.
Update Обновляет указанный сервисный аккаунт.
Delete Удаляет указанный сервисный аккаунт.
ListAccessBindings access Возвращает список привязок прав доступа для указанного сервисного аккаунта.
SetAccessBindings Задает список привязок прав доступа для указанного сервисного аккаунта.
UpdateAccessBindings Обновляет список привязок прав доступа для указанного сервисного аккаунта.
ListOperations Возвращает список операций для указанного сервисного аккаунта.

Вызовы ServiceAccountService

Get

Возвращает указанный ресурс ServiceAccount.
Чтобы получить список доступных ресурсов ServiceAccount, используйте запрос List.

rpc Get (GetServiceAccountRequest) returns (ServiceAccount)

GetServiceAccountRequest

Поле Описание
service_account_id string
Обязательное поле. Идентификатор возвращаемого ресурса ServiceAccount. Чтобы получить идентификатор сервисного аккаунта, используйте запрос ServiceAccountService.List. Максимальная длина строки в символах — 50.

ServiceAccount

Поле Описание
id string
Идентификатор сервисного аккаунта.
folder_id string
Идентификатор каталога, которому принадлежит сервисный аккаунт.
created_at google.protobuf.Timestamp
Время создания.
name string
Имя сервисного аккаунта. Имя должно быть уникальным в облаке. Длина 3-63 символов.
description string
Описание сервисного аккаунта. Длина описания должна быть от 0 до 256 символов.

List

Возвращает список доступных ресурсов ServiceAccount в указанном каталоге.

rpc List (ListServiceAccountsRequest) returns (ListServiceAccountsResponse)

ListServiceAccountsRequest

Поле Описание
folder_id string
Обязательное поле. Идентификатор каталога для получения списка сервисных аккаунтов. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50.
page_size int64
Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListServiceAccountsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000.
page_token string
Токен страницы. Установите значение page_token равным значению поля ListServiceAccountsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
filter string
  1. Имя поля. В настоящее время фильтрация осуществляется только по полю ServiceAccount.name.
  2. Оператор. Операторы = или != для одиночных значений, IN или NOT IN для списков значений.
  3. Значение. Значение длиной от 3 до 63 символов, совпадающее с регулярным выражением ^[a-z][-a-z0-9]{1,61}[a-z0-9]$.
Максимальная длина строки в символах — 1000.

ListServiceAccountsResponse

Поле Описание
service_accounts[] ServiceAccount
Список ресурсов ServiceAccount.
next_page_token string
Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListServiceAccountsRequest.page_size, используйте next_page_token в качестве значения параметра ListServiceAccountsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

ServiceAccount

Поле Описание
id string
Идентификатор сервисного аккаунта.
folder_id string
Идентификатор каталога, которому принадлежит сервисный аккаунт.
created_at google.protobuf.Timestamp
Время создания.
name string
Имя сервисного аккаунта. Имя должно быть уникальным в облаке. Длина 3-63 символов.
description string
Описание сервисного аккаунта. Длина описания должна быть от 0 до 256 символов.

Create

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

rpc Create (CreateServiceAccountRequest) returns (operation.Operation)

Метаданные и результат операции:

    Operation.metadata:CreateServiceAccountMetadata

    Operation.response:ServiceAccount

CreateServiceAccountRequest

Поле Описание
folder_id string
Обязательное поле. Идентификатор каталога, в котором создается сервисный аккаунт. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50.
name string
Обязательное поле. Имя сервисного аккаунта. Имя должно быть уникальным в облаке. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9].
description string
Описание сервисного аккаунта. Максимальная длина строки в символах — 256.

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any<CreateServiceAccountMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any<ServiceAccount>
в случае успешного выполнения операции.

CreateServiceAccountMetadata

Поле Описание
service_account_id string
Идентификатор создаваемого сервисного аккаунта.

ServiceAccount

Поле Описание
id string
Идентификатор сервисного аккаунта.
folder_id string
Идентификатор каталога, которому принадлежит сервисный аккаунт.
created_at google.protobuf.Timestamp
Время создания.
name string
Имя сервисного аккаунта. Имя должно быть уникальным в облаке. Длина 3-63 символов.
description string
Описание сервисного аккаунта. Длина описания должна быть от 0 до 256 символов.

Update

Обновляет указанный сервисный аккаунт.

rpc Update (UpdateServiceAccountRequest) returns (operation.Operation)

Метаданные и результат операции:

    Operation.metadata:UpdateServiceAccountMetadata

    Operation.response:ServiceAccount

UpdateServiceAccountRequest

Поле Описание
service_account_id string
Обязательное поле. Идентификатор обновляемого ресурса ServiceAccount. Чтобы получить идентификатор сервисного аккаунта, используйте запрос ServiceAccountService.List. Максимальная длина строки в символах — 50.
update_mask google.protobuf.FieldMask
Маска, определяющая, какие поля ресурса ServiceAccount будут обновлены.
name string
Обязательное поле. Имя сервисного аккаунта. Имя должно быть уникальным в облаке. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9].
description string
Описание сервисного аккаунта. Максимальная длина строки в символах — 256.

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any<UpdateServiceAccountMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any<ServiceAccount>
в случае успешного выполнения операции.

UpdateServiceAccountMetadata

Поле Описание
service_account_id string
Идентификатор изменяемого ресурса ServiceAccount.

ServiceAccount

Поле Описание
id string
Идентификатор сервисного аккаунта.
folder_id string
Идентификатор каталога, которому принадлежит сервисный аккаунт.
created_at google.protobuf.Timestamp
Время создания.
name string
Имя сервисного аккаунта. Имя должно быть уникальным в облаке. Длина 3-63 символов.
description string
Описание сервисного аккаунта. Длина описания должна быть от 0 до 256 символов.

Delete

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

rpc Delete (DeleteServiceAccountRequest) returns (operation.Operation)

Метаданные и результат операции:

    Operation.metadata:DeleteServiceAccountMetadata

    Operation.response:google.protobuf.Empty

DeleteServiceAccountRequest

Поле Описание
service_account_id string
Обязательное поле. Идентификатор сервисного аккаунта, который следует удалить. Чтобы получить идентификатор сервисного аккаунта, используйте запрос ServiceAccountService.List. Максимальная длина строки в символах — 50.

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any<DeleteServiceAccountMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any<google.protobuf.Empty>
в случае успешного выполнения операции.

DeleteServiceAccountMetadata

Поле Описание
service_account_id string
Идентификатор удаляемого сервисного аккаунта.

ListAccessBindings

access Возвращает список привязок прав доступа для указанного сервисного аккаунта.

rpc ListAccessBindings (ListAccessBindingsRequest) returns (ListAccessBindingsResponse)

ListAccessBindingsRequest

Поле Описание
resource_id string
Обязательное поле. Идентификатор ресурса, для которого запрашивается список привязок прав доступа.
Чтобы получить идентификатор ресурса, используйте соответствующий запрос List. Например, используйте запрос yandex.cloud.resourcemanager.v1.CloudService.List для получения идентификатора ресурса Cloud.
page_size int64
Максимальное число возвращаемых результатов на странице. Если количество результатов больше чем page_size, сервис вернет значение ListAccessBindingsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000.
page_token string
Токен страницы. Установите значение page_token равным значению поля ListAccessBindingsResponse.next_page_token прошлого запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

ListAccessBindingsResponse

Поле Описание
access_bindings[] AccessBinding
Список привязок прав доступа для указанного ресурса.
next_page_token string
Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListAccessBindingsRequest.page_size, используйте next_page_token в качестве значения параметра ListAccessBindingsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

AccessBinding

Поле Описание
role_id string
Идентификатор ресурса yandex.cloud.iam.v1.Role который назначен для субъекта, указанного в параметре subject. Максимальная длина строки в символах — 50.
subject Subject
Обязательное поле. Субъект, для которого создается привязка прав доступа. Может представлять собой аккаунт с уникальным идентификатором в облаке или системную группу с общим системным идентификатором.

Subject

Поле Описание
id string
  • allAuthenticatedUsers: Специальный системный идентификатор, представляющий любого пользователя, прошедшего аутентификацию. Его можно использовать только если в параметре type указано system.
  • allUsers: Специальный системный идентификатор, представляющий любого пользователя. Аутентификация не требуется. Например, при запросе через API не надо будет указывать IAM-токен.
  • <идентификатор пользователя в облаке>: Идентификатор, представляющий учетную запись пользователя. Его можно использовать только если в параметре type передано одно из следующих значений: userAccount или serviceAccount.
Максимальная длина строки в символах — 50.
type string
  • userAccount — аккаунт на Яндексе или [Яндекс.Коннекте]({ {link-yandex-connect} }), добавленный в Яндекс.Облако.
  • serviceAccount — сервисный аккаунт. Этот тип представляет ресурс yandex.cloud.iam.v1.ServiceAccount.
  • federatedUser — федеративный аккаунт. Этот тип представляет пользователя из федерации удостоверений, например Active Directory.
  • system — системная группа. Представляет набор аккаунтов, который описывается общим системным идентификатором.

SetAccessBindings

Задает список привязок прав доступа для указанного сервисного аккаунта.

rpc SetAccessBindings (SetAccessBindingsRequest) returns (operation.Operation)

Метаданные и результат операции:

    Operation.metadata:SetAccessBindingsMetadata

    Operation.response:google.protobuf.Empty

SetAccessBindingsRequest

Поле Описание
resource_id string
Обязательное поле. Идентификатор ресурса, для которого задается список привязок прав доступа.
Чтобы получить идентификатор ресурса, используйте соответствующий запрос List.
access_bindings[] AccessBinding
Обязательное поле. Привязки прав доступа, которые будут установлены. Дополнительные сведения см. в разделе Привязка прав доступа.

AccessBinding

Поле Описание
role_id string
Идентификатор ресурса yandex.cloud.iam.v1.Role который назначен для субъекта, указанного в параметре subject. Максимальная длина строки в символах — 50.
subject Subject
Обязательное поле. Субъект, для которого создается привязка прав доступа. Может представлять собой аккаунт с уникальным идентификатором в облаке или системную группу с общим системным идентификатором.

Subject

Поле Описание
id string
  • allAuthenticatedUsers: Специальный системный идентификатор, представляющий любого пользователя, прошедшего аутентификацию. Его можно использовать только если в параметре type указано system.
  • allUsers: Специальный системный идентификатор, представляющий любого пользователя. Аутентификация не требуется. Например, при запросе через API не надо будет указывать IAM-токен.
  • <идентификатор пользователя в облаке>: Идентификатор, представляющий учетную запись пользователя. Его можно использовать только если в параметре type передано одно из следующих значений: userAccount или serviceAccount.
Максимальная длина строки в символах — 50.
type string
  • userAccount — аккаунт на Яндексе или [Яндекс.Коннекте]({ {link-yandex-connect} }), добавленный в Яндекс.Облако.
  • serviceAccount — сервисный аккаунт. Этот тип представляет ресурс yandex.cloud.iam.v1.ServiceAccount.
  • federatedUser — федеративный аккаунт. Этот тип представляет пользователя из федерации удостоверений, например Active Directory.
  • system — системная группа. Представляет набор аккаунтов, который описывается общим системным идентификатором.

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any<SetAccessBindingsMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any<google.protobuf.Empty>
в случае успешного выполнения операции.

SetAccessBindingsMetadata

Поле Описание
resource_id string
Идентификатор ресурса, для которого задается список привязок прав доступа.

UpdateAccessBindings

Обновляет список привязок прав доступа для указанного сервисного аккаунта.

rpc UpdateAccessBindings (UpdateAccessBindingsRequest) returns (operation.Operation)

Метаданные и результат операции:

    Operation.metadata:UpdateAccessBindingsMetadata

    Operation.response:google.protobuf.Empty

UpdateAccessBindingsRequest

Поле Описание
resource_id string
Обязательное поле. Идентификатор ресурса, для которого обновляется список привязок прав доступа.
access_binding_deltas[] AccessBindingDelta
Обязательное поле. Изменения в список привязок прав доступа.

AccessBindingDelta

Поле Описание
action enum AccessBindingAction
Обязательное поле. Действие, которое надо выполнить с привязкой прав доступа.
  • ADD: Добавление новой привязки прав доступа.
  • REMOVE: Удаление привязки прав доступа.
    access_binding AccessBinding
    Обязательное поле. Привязка прав доступа. Дополнительные сведения см. в разделе Привязка прав доступа.

    AccessBinding

    Поле Описание
    role_id string
    Идентификатор ресурса yandex.cloud.iam.v1.Role который назначен для субъекта, указанного в параметре subject. Максимальная длина строки в символах — 50.
    subject Subject
    Обязательное поле. Субъект, для которого создается привязка прав доступа. Может представлять собой аккаунт с уникальным идентификатором в облаке или системную группу с общим системным идентификатором.

    Subject

    Поле Описание
    id string
    • allAuthenticatedUsers: Специальный системный идентификатор, представляющий любого пользователя, прошедшего аутентификацию. Его можно использовать только если в параметре type указано system.
    • allUsers: Специальный системный идентификатор, представляющий любого пользователя. Аутентификация не требуется. Например, при запросе через API не надо будет указывать IAM-токен.
    • <идентификатор пользователя в облаке>: Идентификатор, представляющий учетную запись пользователя. Его можно использовать только если в параметре type передано одно из следующих значений: userAccount или serviceAccount.
    Максимальная длина строки в символах — 50.
    type string
    • userAccount — аккаунт на Яндексе или [Яндекс.Коннекте]({ {link-yandex-connect} }), добавленный в Яндекс.Облако.
    • serviceAccount — сервисный аккаунт. Этот тип представляет ресурс yandex.cloud.iam.v1.ServiceAccount.
    • federatedUser — федеративный аккаунт. Этот тип представляет пользователя из федерации удостоверений, например Active Directory.
    • system — системная группа. Представляет набор аккаунтов, который описывается общим системным идентификатором.

    Operation

    Поле Описание
    id string
    Идентификатор операции.
    description string
    Описание операции. Длина описания должна быть от 0 до 256 символов.
    created_at google.protobuf.Timestamp
    Время создания ресурса в формате в RFC3339.
    created_by string
    Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
    modified_at google.protobuf.Timestamp
    Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
    done bool
    Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
    metadata google.protobuf.Any<UpdateAccessBindingsMetadata>
    Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
    result oneof: error или response
    Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
      error google.rpc.Status
    Описание ошибки в случае сбоя или отмены операции.
      response google.protobuf.Any<google.protobuf.Empty>
    в случае успешного выполнения операции.

    UpdateAccessBindingsMetadata

    Поле Описание
    resource_id string
    Идентификатор ресурса, для которого обновляется список привязок прав доступа.

    ListOperations

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

    rpc ListOperations (ListServiceAccountOperationsRequest) returns (ListServiceAccountOperationsResponse)

    ListServiceAccountOperationsRequest

    Поле Описание
    service_account_id string
    Обязательное поле. Идентификатор ресурса ServiceAccount, для которого запрашивается список операций. Максимальная длина строки в символах — 50.
    page_size int64
    Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListServiceAccountOperationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000.
    page_token string
    Токен страницы. Установите значение page_token равным значению поля ListServiceAccountOperationsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

    ListServiceAccountOperationsResponse

    Поле Описание
    operations[] operation.Operation
    Список операций для указанного сервисного аккаунта.
    next_page_token string
    Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListServiceAccountOperationsRequest.page_size, используйте next_page_token в качестве значения параметра ListServiceAccountOperationsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

    Operation

    Поле Описание
    id string
    Идентификатор операции.
    description string
    Описание операции. Длина описания должна быть от 0 до 256 символов.
    created_at google.protobuf.Timestamp
    Время создания ресурса в формате в RFC3339.
    created_by string
    Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
    modified_at google.protobuf.Timestamp
    Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
    done bool
    Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
    metadata google.protobuf.Any
    Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
    result oneof: error или response
    Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
      error google.rpc.Status
    Описание ошибки в случае сбоя или отмены операции.
      response google.protobuf.Any
    Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.
    В этой статье: