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

CertificateService

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

Вызов Описание
Get Возвращает указанный сертификат.
List Возвращает список сертификатов для указанной федерации.
Create Добавляет сертификат для указанной федерации.
Update Обновляет указанный сертификат.
Delete Удаляет указанный сертификат.
ListOperations Перечисляет операции для указанного сертификата.

Вызовы CertificateService

Get

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

rpc Get (GetCertificateRequest) returns (Certificate)

GetCertificateRequest

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

Certificate

Поле Описание
id string
Обязательное поле. Идентификатор сертификата. false Максимальная длина строки в символах — 50.
federation_id string
Обязательное поле. Идентификатор федерации, которой принадлежит сертификат. false Максимальная длина строки в символах — 50.
name string
Имя сертификата. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9].
description string
Описание сертификата. Длина описания должна быть от 0 до 256 символов. Максимальная длина строки в символах — 256.
created_at google.protobuf.Timestamp
Время создания.
data string
Обязательное поле. Данные сертификата в формате PEM. false Максимальная длина строки в символах — 32000.

List

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

rpc List (ListCertificatesRequest) returns (ListCertificatesResponse)

ListCertificatesRequest

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

ListCertificatesResponse

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

Certificate

Поле Описание
id string
Обязательное поле. Идентификатор сертификата. false Максимальная длина строки в символах — 50.
federation_id string
Обязательное поле. Идентификатор федерации, которой принадлежит сертификат. false Максимальная длина строки в символах — 50.
name string
Имя сертификата. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9].
description string
Описание сертификата. Длина описания должна быть от 0 до 256 символов. Максимальная длина строки в символах — 256.
created_at google.protobuf.Timestamp
Время создания.
data string
Обязательное поле. Данные сертификата в формате PEM. false Максимальная длина строки в символах — 32000.

Create

Добавляет сертификат для указанной федерации.

rpc Create (CreateCertificateRequest) returns (operation.Operation)

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

    Operation.metadata:CreateCertificateMetadata

    Operation.response:Certificate

CreateCertificateRequest

Поле Описание
federation_id string
Идентификатор федерации для добавления нового сертификата. Чтобы получить идентификатор федерации, используйте запрос [yandex.cloud.iam.v1.FederationService.List]. Максимальная длина строки в символах — 50.
name string
Имя сертификата. Имя должно быть уникальным в пределах федерации. Значение должно соответствовать регулярному выражению [a-z]([-a-z0-9]{0,61}[a-z0-9])?.
description string
Описание сертификата. Максимальная длина строки в символах — 256.
data string
Данные сертификата в формате PEM. Максимальная длина строки в символах — 32000.

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<CreateCertificateMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Certificate>
в случае успешного выполнения операции.

CreateCertificateMetadata

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

Certificate

Поле Описание
id string
Обязательное поле. Идентификатор сертификата. false Максимальная длина строки в символах — 50.
federation_id string
Обязательное поле. Идентификатор федерации, которой принадлежит сертификат. false Максимальная длина строки в символах — 50.
name string
Имя сертификата. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9].
description string
Описание сертификата. Длина описания должна быть от 0 до 256 символов. Максимальная длина строки в символах — 256.
created_at google.protobuf.Timestamp
Время создания.
data string
Обязательное поле. Данные сертификата в формате PEM. false Максимальная длина строки в символах — 32000.

Update

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

rpc Update (UpdateCertificateRequest) returns (operation.Operation)

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

    Operation.metadata:UpdateCertificateMetadata

    Operation.response:Certificate

UpdateCertificateRequest

Поле Описание
certificate_id string
Идентификатор сертификата для обновления. Чтобы получить идентификатор сертификата, используйте запрос CertificateService.List. Максимальная длина строки в символах — 50.
update_mask google.protobuf.FieldMask
Маска, определяющая, какие поля указанного сертификата будут обновлены.
name string
Имя сертификата. Имя должно быть уникальным в пределах федерации. Значение должно соответствовать регулярному выражению |[a-z]([-a-z0-9]{0,61}[a-z0-9])?.
description string
Описание сертификата. Максимальная длина строки в символах — 256.
data string
Данные сертификата в формате PEM. Максимальная длина строки в символах — 32000.

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<UpdateCertificateMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Certificate>
в случае успешного выполнения операции.

UpdateCertificateMetadata

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

Certificate

Поле Описание
id string
Обязательное поле. Идентификатор сертификата. false Максимальная длина строки в символах — 50.
federation_id string
Обязательное поле. Идентификатор федерации, которой принадлежит сертификат. false Максимальная длина строки в символах — 50.
name string
Имя сертификата. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9].
description string
Описание сертификата. Длина описания должна быть от 0 до 256 символов. Максимальная длина строки в символах — 256.
created_at google.protobuf.Timestamp
Время создания.
data string
Обязательное поле. Данные сертификата в формате PEM. false Максимальная длина строки в символах — 32000.

Delete

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

rpc Delete (DeleteCertificateRequest) returns (operation.Operation)

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

    Operation.metadata:DeleteCertificateMetadata

    Operation.response:google.protobuf.Empty

DeleteCertificateRequest

Поле Описание
certificate_id string
Идентификатор сертификата, который следует удалить. Чтобы получить идентификатор сертификата, используйте запрос CertificateService.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<DeleteCertificateMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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>
в случае успешного выполнения операции.

DeleteCertificateMetadata

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

ListOperations

Перечисляет операции для указанного сертификата.

rpc ListOperations (ListCertificateOperationsRequest) returns (ListCertificateOperationsResponse)

ListCertificateOperationsRequest

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

ListCertificateOperationsResponse

Поле Описание
operations[] operation.Operation
Список операций для указанного сертификата.
next_page_token string
Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListCertificateOperationsRequest.page_size, используйте next_page_token в качестве значения параметра ListCertificateOperationsRequest.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.