Заявка на отзыв RSA-сертификата

Песочница

POST https://sandbox.alfabank.ru/api/signature/users/{sub}/rsa-certificates/{certificateId}/requests/revocation

Пром

POST https://baas.alfabank.ru/api/signature/users/{sub}/rsa-certificates/{certificateId}/requests/revocation

Scope

signature

Описание

Метод предназначен для создания заявки на отзыв RSA-сертификата.

Параметры запроса

HEADERS

Атрибут

Описание

Authorization

stringrequired

Возможны два варианта:

•

Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H
•

ApiKey {API Key}, полученный через Портал разработчика

stringrequired

application/json

PATH

Атрибут

Описание

sub

stringrequired

Идентификатор субъекта

certificateId

stringrequired

Идентификатор сертификата из метода Получение RSA-сертификата

Пример запроса

Язык

1curl --location --globoff --request POST 'https://baas.alfabank.ru/api/signature/users/{sub}/rsa-certificates/{certificateId}/requests/revocation' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'

Параметры ответа

Пример ответа 200 (OK)

1{
2  "id": "62550ef50163785f2222707e",
3  "type": "revocationRsaCertificate",
4  "status": "CREATED",
5  "creator": "Ефимов Филипп Архипович",
6  "createdDate": "2022-04-12T05:32:37.509Z"
7}

BODY

атрибут

описание

stringrequired

Идентификатор заявки

type

stringrequired

Тип заявки

status

stringrequired

Статус заявки

creator

stringrequired

ФИО создателя заявки

createdDate

string(date-time)required

Дата создания заявки

Пример ответа 200 (OK)

1{
2  "id": "62550ef50163785f2222707e",
3  "type": "revocationRsaCertificate",
4  "status": "CREATED",
5  "creator": "Ефимов Филипп Архипович",
6  "createdDate": "2022-04-12T05:32:37.509Z"
7}

BODY

атрибут

описание

error

stringrequired

Код ошибки. Принимает возможные значения:

•

invalid_request - неверные входные параметры запроса

error_description

stringoptional

Описание ошибки

Пример ошибки 400 (Bad Request)

1{
2  "error": "invalid_request",
3  "error_description": "Authorization header is not present in request headers"
4}

BODY

атрибут

описание

error

stringrequired

Код ошибки. Принимает возможные значения:

•

invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощью refresh_token. При отзыве токена необходимо заново пройти авторизацию

error_description

stringoptional

Описание ошибки

Пример ошибки 401 (Unauthorized)

1{
2  "error": "invalid_token",
3  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}

BODY

атрибут

описание

error

stringrequired

Код ошибки. Принимает возможные значения:

•

insufficient_scope - при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметра prompt=consent;
•

access_denied - доступ к счёту запрещён

error_description

stringoptional

Описание ошибки

Пример ошибки 403 (Forbidden)

1{
2  "error": "insufficient_scope",
3  "error_description": "The request requires higher privileges than provided by the access token"
4}

BODY

атрибут

описание

error

stringrequired

Код ошибки. Принимает возможные значения:

•

unknown_endpoint - эндпоинт не найден или неактивен

error_description

stringoptional

Описание ошибки

Пример ошибки 404 (Not Found)

1{
2  "error": "unknown_endpoint",
3  "error_description": "Endpoint is not found or not active"
4}

BODY

атрибут

описание

error

stringrequired

Код ошибки. Принимает возможные значения:

•

ot valid pkcs10 DN - невалидный DN

error_description

stringoptional

Описание ошибки

Пример ошибки 422 (Unprocessable Entity)

1{
2  "error": "Not valid pkcs10 DN",
3  "error_description": "Wrong dn [DN(firstName=Евстафий, lastName=Жданов, fullName=Жданов Евстафий Юльевич, country=RU, area=Ленинградская обл., city=null, address=null, email=User513@pochtochka.com)] from pkcs10 for user [XBOXWG]"
4}

Нет тела ответа

BODY

атрибут

описание

error

stringrequired

Код ошибки. Принимает возможные значения:

•

internal_error - внутренняя ошибка сервиса при выполнении обработки запроса

error_description

stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error)

1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}

Нет тела ответа

Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.