B2BH2H

Заявка на изменение текущего способа подписи

Песочница
PUT https://sandbox.alfabank.ru/api/jp/v3/signature/sign-settings
Пром
PUT https://baas.alfabank.ru/api/jp/v3/signature/sign-settings
Scope

signature

Описание
Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

Content-Type
stringrequired

application/json

BODY
Атрибут
Описание
currentSignType
stringrequired

Тип текущего способа подписи. Возможные значения:

  • •
    rsa-certificates - подпись с помощью RSA-сертификата;
  • •
    qes - подпись с помощью КЭП
Пример запроса
Язык 
1curl --location --request PUT 'https://baas.alfabank.ru/api/jp/v3/signature/sign-settings' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "currentSignType": "rsa-certificates"
7}'
Параметры ответа
Пример ответа 200 (OK) 
1{
2  "id": "632b8d134441931c3de7098f",
3  "type": "currentSignTypeRsa",
4  "status": "CREATED",
5  "creator": "Павлов Ким Николаевич",
6  "createdDate": "2022-09-21T22:15:47.500Z"
7}
BODY
атрибут
описание
id
stringrequired

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

type
stringrequired

Тип заявки. Принимает возможные значения:

  • •
    currentSignTypeRsa - тип заявки на изменение текущего способа подписи на RSA
  • •
    currentSignTypeQes - тип заявки на изменение текущего способа подписи на КЭП
status
stringrequired

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

creator
stringrequired

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

createdDate
stringrequired

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

Пример ответа 200 (OK) 
1{
2  "id": "632b8d134441931c3de7098f",
3  "type": "currentSignTypeRsa",
4  "status": "CREATED",
5  "creator": "Павлов Ким Николаевич",
6  "createdDate": "2022-09-21T22:15:47.500Z"
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
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

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

  • •
    Not valid pkcs10 DN - невалидный DN;
  • •
    not_allowed_action - попытка изменить способ подписи на тот, который уже используется
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}
Нет тела ответа

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

Заявка на изменение текущего способа подписиЗаявка на переключение на другой RSA-сертификат