B2BB2CH2H

Данные по согласиям пользователей

Песочница
GET https://sandbox.alfabank.ru/oidc/client-consents
Пром
GET https://baas.alfabank.ru/oidc/client-consents
Описание

Данный метод можно включать в scope с типом гранта Client Credentials Flow или с типом гранта Authorization Code Flow.

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

Bearer {access_token}

Accept
stringrequired

application/json

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

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

sub
stringoptional

Идентификатор субъекта (пользователя)

organizationIdHash
stringoptional

Хэш идентификатора ЮЛ (организации)

isActive
booleanoptional

Признак активного согласия

limit
integeroptional

Количество объектов на одной странице. Значение по умолчанию: 1000

offset
integeroptional

Количество объектов в списке, которые необходимо пропустить. Значение по умолчанию: 0

Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/oidc/client-consents?clientId={clientId}&sub={sub}&organizationIdHash={organizationIdHash}&isActive={isActive}&limit={limit}&offset={offset}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "pagination": {
3    "limit": 1,
4    "offset": 0,
5    "totalCount": 1000
6  },
7  "items": [
8    {
9      "createDateTime": "2022-10-10T12:15:10",
10      "sub": "3228e68e-cc34-4b82-b43d-49112b5d9d3e",
11      "organizationIdHash": "665f4c5837ea35d1b081f4feb05de61522b6854c2268583f3f5865a0981f9268",
12      "clientId": "0cee0683-85ae-49f2-a63d-29f97aad1911",
13      "isActive": true,
14      "expireDate": "2023-04-10"
15    }
16  ]
17}
HEADERS
Атрибут
Описание
Content-Type
stringoptional

application/json

BODY
атрибут
описание
objectoptional

Данные пагинации

limit
numberoptional

Количество записей на одной странице

offset
numberoptional

Количество записей в списке, которые были пропущены

totalCount
numberoptional

Общее количество записей

array of objectsoptional

Массив объектов результата

createDateTime
stringrequired

Дата и время создания

sub
stringrequired

Идентификатор субъекта (пользователя)

organizationIdHash
stringoptional

Хэш идентификатора ЮЛ (организации)

clientId
stringrequired

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

isActive
booleanrequired

Признак активного согласия

expireDate
stringrequired

Дата окончания действия

Пример ответа 200 (OK)
1{
2  "pagination": {
3    "limit": 1,
4    "offset": 0,
5    "totalCount": 1000
6  },
7  "items": [
8    {
9      "createDateTime": "2022-10-10T12:15:10",
10      "sub": "3228e68e-cc34-4b82-b43d-49112b5d9d3e",
11      "organizationIdHash": "665f4c5837ea35d1b081f4feb05de61522b6854c2268583f3f5865a0981f9268",
12      "clientId": "0cee0683-85ae-49f2-a63d-29f97aad1911",
13      "isActive": true,
14      "expireDate": "2023-04-10"
15    }
16  ]
17}
HEADERS
Атрибут
Описание
Content-Type
stringoptional

application/json

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

application/json

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

application/json

BODY
атрибут
описание
error
stringrequired

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

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

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

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

Отправьте письмо на alfa_api@alfabank.ru, указав следующие данные:

  1. 1.
    client_id.
  2. 2.
    Дата и время запроса с указанием часового пояса.
  3. 3.
    Метод и URI запроса.
  4. 4.
    Заголовки и тело запроса.
  5. 5.
    Полученная ошибка и заголовки ответа, включая X-TraceId.
  6. 6.
    IP-адрес, с которого был отправлен запрос.