API для работы с динамическими клиентами#

Внимание

API-запросы отправляются на адрес https://login.company.com/<context>/<url>, где context — заданный относительный путь до сервисов Blitz Identity Provider, url - адрес метода, приведенный в настоящем разделе. По умолчанию API-запросы отправляются на https://login.company.com/blitz/<url>.

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

API позволяет:

генерировать software_statement;
получать список Initial Access Token (IAT) приложения;
создавать IAT;
удалять IAT.

Методы API вызываются через административные сервисы по адресу:

/admin/api/v3/app/{appId}/oauth/...

где {appId} — идентификатор приложения, для которого выполняется операция.

Внимание

Необходимо указать разрешения (scope) blitz_api_sys_app и blitz_api_sys_app_chg среди допустимых разрешений, которые имеет право запрашивать данное приложение.

Генерация software_statement#

Метод

PUT /admin/api/v3/app/{appId}/oauth/softStm

Генерирует software_statement.

Авторизация

Bearer {token}, где token — это маркер доступа вызывающей системы, содержащий разрешение blitz_api_sys_app_chg.

Тело запроса

JSON:

softwareVersion - версия приложения (обязательный параметр);

Внимание

Версия приложения должна соответствовать версии первичного маркера IAT, используемого приложением.
redirectUris - префиксы ссылок возврата. Префикс используется для проверки ссылок возврата. Если в запросе на аутентификацию указана ссылка возврата и она не соответствует ни одному из указанных префиксов, то в аутентификации будет отказано.
tokenEndpointAuthMethod - метод аутентификации при обращении к сервису выдачи маркеров. Указанный метод аутентификации должен использоваться инстансом приложения при обращении к сервису выдачи маркеров.
grantTypes - список grant type, которые будут доступны экземпляру приложения.
responseTypes - список response type, которые будут доступны экземпляру приложения при обращении к URL авторизации.
scope - разрешения (scope), которые будут доступны приложению.

Пример

Запрос

curl --location --request PUT 'https://login.company.com/blitz/admin/api/v3/app/exampleApp/oauth/softStm' \
--header 'Authorization: Bearer eyJra...CQQ' \
--header 'Content-Type: application/json' \
--data-raw '{
   "softwareVersion": "1",
   "redirectUris": [
      "https://example.com/callback"
   ],
   "tokenEndpointAuthMethod": "client_secret_basic",
   "grantTypes": [
      "authorization_code"
   ],
   "responseTypes": [
      "code",
      "token"
   ],
   "scope": [
      "openid",
      "profile"
   ]
}'

Ответы

Успех#

200 ОК

"eyJr...QJA"

Ошибка авторизации#

401 Unauthorized

{
   "type": "security_error",
   "error": "bad_access_token",
   "desc": "token_not_found"
}

Ошибка при указании некорректного идентификатора приложения#

404 Not Found

{
   "type": "process_error",
   "error": "client_not_found",
   "desc": "unknown client 'badAppId'"
}

Ошибки значений полей запроса#

400 Bad Request

{
   "type": "input_error",
   "error": "wrong_values",
   "errors": [
   {
         "type": "input_error",
         "error": "json.error.mandatory.field",
         "desc": "json.error.expected.string",
         "pos": "softwareVersion"
   },
   {
         "type": "input_error",
         "error": "json.error.expected.uri",
         "desc": "Illegal character in scheme name at index 0: а:ff",
         "pos": "redirectUris.[0]"
   },
      {
         "type": "input_error",
         "error": "wrong_value",
         "desc": "unexpected values [authorization_code1]",
         "pos": "grantTypes"
      },
      {
         "type": "input_error",
         "error": "wrong_value",
         "desc": "unexpected values [token1]",
         "pos": "responseTypes"
      },
      {
         "type": "input_error",
         "error": "wrong_value",
         "desc": "wrong value client_secret_basic1, expected some of [none,client_secret_basic,client_secret_post]",
         "pos": "tokenEndpointAuthMethod"
      },
      {
         "type": "input_error",
         "error": "wrong_value",
         "desc": "unexpected values [profile1]",
         "pos": "scope"
      }
   ]
}

Получение IAT приложения#

Метод

GET /admin/api/v3/app/{appId}/oauth/iat

Возвращает IAT приложения.

Авторизация

Bearer {token}, где token — это маркер доступа вызывающей системы, содержащий разрешение blitz_api_sys_app.

Пример

Запрос

curl --location --request GET 'https://login.company.com/blitz/admin/api/v3/app/exampleApp/oauth/iat' \
--header 'Authorization: Bearer eyJra...qElQ' \

Ответы

Успех#

200 ОК

[
   {
      "createdOn": 1769437759,
      "softwareVersion": "1",
      "softwareId": "exampleApp",
      "id": "ZYzL...mQ"
   }
]

Ошибка авторизации#

401 Unauthorized

{
   "type": "security_error",
   "error": "bad_access_token",
   "desc": "token_not_found"
}

Ошибка вызова с некорректным идентификатором приложения#

404 Not Found

{
   "type": "process_error",
   "error": "client_not_found",
   "desc": "unknown client 'badAppId'"
}

Создание IAT приложения#

Метод

PUT /admin/api/v3/app/{appId}/oauth/iat

Создает IAT приложения.

Авторизация

Bearer {token}, где token — это маркер доступа вызывающей системы, содержащий разрешение blitz_api_sys_app_chg.

Тело запроса

JSON:

softwareVersion - версия приложения (обязательный параметр).

Пример

Запрос

curl --location --request PUT 'https://login.company.com/blitz/admin/api/v3/app/exampleApp/oauth/iat' \
--header 'Authorization: Bearer eyJra...ElQ' \
--header 'Content-Type: application/json' \
--data-raw '{
   "softwareVersion": "1"
}'

Ответы

Успех#

200 ОК

{
   "createdOn": 1769594410,
   "softwareVersion": "1",
   "softwareId": "exampleApp",
   "id": "GbhF...qw"
}

Ошибка авторизации#

401 Unauthorized

{
   "type": "security_error",
   "error": "bad_access_token",
   "desc": "token_not_found"
}

Ошибка вызова с некорректным идентификатором приложения#

404 Not Found

{
   "type": "process_error",
   "error": "client_not_found",
   "desc": "unknown client 'badAppId'"
}

Ошибки значений полей запроса#

400 Bad Request

{
   "type": "input_error",
   "error": "wrong_values",
   "errors": [
   {
         "type": "input_error",
         "error": "json.error.mandatory.field",
         "desc": "json.error.expected.string",
         "pos": "softwareVersion"
   }
   ]
}

Удаление IAT приложения#

Метод

DELETE /admin/api/v3/app/{appId}/oauth/iat/{tokenId}

Удаляет IAT приложения.

Авторизация

Bearer {token}, где token — это маркер доступа вызывающей системы, содержащий разрешение blitz_api_sys_app_chg.

Пример

Запрос

curl --location --request DELETE 'https://login.company.com/blitz/admin/api/v3/app/exampleApp/oauth/iat/SmCYp...aqw' \
--header 'Authorization: Bearer eyJra...ElQ'

Ответы

Успех#

204 No Content

Ошибка авторизации#

401 Unauthorized

{
   "type": "security_error",
   "error": "bad_access_token",
   "desc": "token_not_found"
}

Ошибка вызова с некорректным идентификатором приложения#

404 Not Found

{
   "type": "process_error",
   "error": "client_not_found",
   "desc": "unknown client 'badAppId'"
}