B2BB2CH2H

Client secret

Песочница
POST https://sandbox.alfabank.ru/oidc/clients/{clientId}/client-secret
Пром
POST https://baas.alfabank.ru/oidc/clients/{clientId}/client-secret
Описание

client_secret представляет собой уникальную строку символов, которая генерируется один раз и не меняется в процессе работы. Достаточно получить его один раз и не менять в дальнейшем.

При необходимости вы можете использовать этот метод для замены client_secret или в случае компроментации client_secret для получения нового.

Если оперативная замена client_secret невозможна, необходимо уведомить банк о факте компрометации client_secret по адресу электронной почты: alfa_api@alfabank.ru.

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

application/json

PATH
Атрибут
Описание
clientId
stringoptional

Идентификатор партнёрского сервиса

Пример запроса
Язык
1curl --location --globoff --request POST 'https://baas.alfabank.ru/oidc/clients/{clientId}/client-secret' \
2--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "clientId": "0cee0683-85ae-49f2-a63d-29f97aad1911",
3  "clientSecret": "Qwerty1234567890Qwerty1234567890!"
4}
BODY
атрибут
описание
clientId
stringoptional

Идентификатор партнёрского сервиса

clientSecret
stringoptional

Секретный ключ партнёрского сервиса

Пример ответа 200 (OK)
1{
2  "clientId": "0cee0683-85ae-49f2-a63d-29f97aad1911",
3  "clientSecret": "Qwerty1234567890Qwerty1234567890!"
4}
HEADERS
Атрибут
Описание
Content-Type
stringoptional
BODY
атрибут
описание
error
stringrequired

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

  • •
    invalid_request - в запросе отсутствует обязательный параметр, он включает неподдерживаемый параметр или значение параметра, повторяет один и тот же параметр, использует более одного метода для включения токена доступа или имеет другой неправильный формат. Сервер ресурсов ДОЛЖЕН ответить кодом состояния HTTP 400 (Bad Request)
error_description
stringoptional

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

Пример ошибки 400 (Bad Request)
1{
2  "error": "invalid_request",
3  "error_description": "Authorization header is not present in request headers"
4}
HEADERS
Атрибут
Описание
Content-Type
stringoptional
BODY
атрибут
описание
error
stringrequired

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

  • •
    invalid_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}
HEADERS
Атрибут
Описание
Content-Type
stringoptional
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}
HEADERS
Атрибут
Описание
Content-Type
stringoptional
BODY
атрибут
описание
error
stringrequired

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

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

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

Пример ошибки 500 (Internal Server Error)
1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}