Перейти к содержимому
docs.
WORKSPACE

Документации проектов

Открыть каталог проектов
Localzet ServerАсинхронный PHP-серверTriangleФреймворк и компонентыMIX IDИдентификация и интеграции✓Hack APIПубличные API хакатонаACNПроект и компонентыUserlay / UserNetПроект и компонентыAxiomПроект и компонентыМесседжинг через почтуПроект и компонентыLWT / JWT / JOSEПроект и компонентыФинансовая аналитика KimaiПроект и компонентыМультипарадигмальная БДПроект и компонентыZorin PlatformПроект и компонентыZorin TrustПроект и компонентыFloraScope / VegwatchПроект и компонентыaegis-qДокументация проектаaevumdbДокументация проектаauditДокументация проектаauto-invest-managerАвтотрейдерcaine-companionДокументация проектаcertbot-cloudflareДокументация проектаClusterLocalzet Server / ClustercmdveilДокументация проектаConsolePHP CLICronБиблиотеки Localzet Serverdata-connectorДокументация проектаdevice-controlDevice Controlenn-projectДокументация проектаEventsБиблиотеки Localzet ServerflowsintДокументация проектаforgeДокументация проектаHttpClientБиблиотеки Localzet ServerinterpreterСобственный языкinvariaДокументация проектаkeynotesДокументация проектаknotrouteKnotroutelaravel-personal-analyticsДокументация проектаlocalzet-osДокументация проектаmeridianДокументация проектаMQTTБиблиотеки Localzet Servernano-kernelСобственная ОСNoterДокументация проектаpersonal-analyticsДокументация проектаProxyБиблиотеки Localzet ServerPSRБиблиотеки Localzet ServerPSR-7Библиотеки Localzet Serverrschs-monitorДокументация проектаsemsealДокументация проектаshardsealДокументация проектаSocketIOБиблиотеки Localzet ServerSOCKS5Библиотеки Localzet Serverstandalone-analyticsДокументация проектаstatic-php-cliДокументация проектаStorageБиблиотеки Localzet ServersutureДокументация проектаtempoweaveДокументация проектаttsСинтез речиTunnelБиблиотеки Localzet Serverui-kitUI KitvesperДокументация проектаWebAnalyzerWebAnalyzerzorin-access-brokerДокументация проектаzorin-authority-brokerДокументация проектаzorin-authority-sdk-phpДокументация проектаzorin-authority-sdk-pythonДокументация проектаzorin-authority-sdk-tsДокументация проектаzorin-client-intelДокументация проектаzorin-device-core-aospДокументация проектаzorin-host-agentДокументация проектаzorin-native-labДокументация проектаzorin-nodeДокументация проектаzorin-opsДокументация проектаdonstu-python-sdkДокументация проектаfloortraceFloortraceserver-rsLocalzet Server / Cluster
Каталог

Справочник API

Source-reviewed integration profile, not a certification of standards compliance or full live authenticated verification. No internal admin or native session routes. Closed source licensing is separate.

OpenAPI 3.1 JSON. Базовый адрес: https://id.zorin.cloud. Страница не отправляет запросы. Обязательность относится к родительскому объекту или выбранному grant-варианту, не ко всем альтернативам сразу.

OIDC discovery

Аутентификация: Security scheme не задана; правила клиента/flow всё равно могут применяться.

HTTPЗначение
200Успешный ответ

response.200

ПолеТипОбязательно у родителяОграничения / описание
issuerstringДаformat: “uri”
authorization_endpointstringДаformat: “uri”
pushed_authorization_request_endpointstringДаformat: “uri”
token_endpointstringДаformat: “uri”
device_authorization_endpointstringДаformat: “uri”
userinfo_endpointstringДаformat: “uri”
jwks_uristringДаformat: “uri”
revocation_endpointstringДаformat: “uri”
introspection_endpointstringДаformat: “uri”
end_session_endpointstringДаformat: “uri”
response_types_supportedarrayДа
grant_types_supportedarrayДа
subject_types_supportedarrayДа
id_token_signing_alg_values_supportedarrayДа
code_challenge_methods_supportedarrayДа
scopes_supportedarrayДа
token_endpoint_auth_methods_supportedarrayДа

response.200.response_types_supported

response.200.response_types_supported[] (Элемент массива)

Тип: string.

response.200.grant_types_supported

response.200.grant_types_supported[] (Элемент массива)

Тип: string.

response.200.subject_types_supported

response.200.subject_types_supported[] (Элемент массива)

Тип: string.

response.200.id_token_signing_alg_values_supported

response.200.id_token_signing_alg_values_supported[] (Элемент массива)

Тип: string.

response.200.code_challenge_methods_supported

response.200.code_challenge_methods_supported[] (Элемент массива)

Тип: string.

response.200.scopes_supported

response.200.scopes_supported[] (Элемент массива)

Тип: string.

response.200.token_endpoint_auth_methods_supported

response.200.token_endpoint_auth_methods_supported[] (Элемент массива)

Тип: string.

Публичные ключи подписи

Аутентификация: Security scheme не задана; правила клиента/flow всё равно могут применяться.

HTTPЗначение
200Успешный ответ

response.200

ПолеТипОбязательно у родителяОграничения / описание
keysarrayДа

response.200.keys

response.200.keys[] (Элемент массива)

Тип: object. Public JWK, no private key material.

Authorization Code + PKCE или одноразовый PAR request_uri

Direct request requires AuthorizationRequest fields. PAR form requires client_id + request_uri. state/nonce are required by integration security guidance even though current handler stores missing values as null. Redirect URI must match registration; HTTPS except loopback.

Аутентификация: Security scheme не задана; правила клиента/flow всё равно могут применяться.

ИмяГдеТипОбязательноОграничения
response_typequery“code”Нет
client_idquerystringНет
redirect_uriquerystringНетformat: “uri”
scopequerystringНетТребует openid; сторонние клиенты ограничены openid/profile/email/offline_access.
statequerystringНет
noncequerystringНет
code_challengequerystringНет
code_challenge_methodquery“S256”Нет
request_uriquerystringНет
HTTPЗначение
302Hosted interaction redirect
400Некорректные параметры
401Неверный клиент, учётные данные, токен или grant
429Превышена частота запросов

response.400

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.400.message

response.400.message — oneOf Вариант 1

Тип: string.

response.400.message — oneOf Вариант 2

response.400.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

response.401

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.401.message

response.401.message — oneOf Вариант 1

Тип: string.

response.401.message — oneOf Вариант 2

response.401.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

response.429

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.429.message

response.429.message — oneOf Вариант 1

Тип: string.

response.429.message — oneOf Вариант 2

response.429.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

Pushed Authorization Request

Public clients are accepted in this source profile; confidential clients authenticate. request_uri is single-use, bound to client, TTL 90 seconds. Current source uses Nest default HTTP 201 for successful POST. This is a compatibility finding, not a statement of OAuth compliance.

Аутентификация: Правила клиента endpoint / clientBasic

request

ПолеТипОбязательно у родителяОграничения / описание
response_type“code”Да
client_idstringДа
redirect_uristringДаformat: “uri”
scopestringДаТребует openid; сторонние клиенты ограничены openid/profile/email/offline_access.
statestringНет
noncestringНет
code_challengestringДа
code_challenge_method“S256”Да
client_secretstringНет
HTTPЗначение
201Запрос авторизации сохранён
400Некорректные параметры
401Неверный клиент, учётные данные, токен или grant
429Превышена частота запросов

response.201

ПолеТипОбязательно у родителяОграничения / описание
request_uristringДа
expires_in90Да

response.400

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.400.message

response.400.message — oneOf Вариант 1

Тип: string.

response.400.message — oneOf Вариант 2

response.400.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

response.401

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.401.message

response.401.message — oneOf Вариант 1

Тип: string.

response.401.message — oneOf Вариант 2

response.401.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

response.429

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.429.message

response.429.message — oneOf Вариант 1

Тип: string.

response.429.message — oneOf Вариант 2

response.429.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

Token endpoint

Grant must be allowed for the client. THIRD_PARTY machine grants disabled. Refresh tokens rotate; reuse revokes family and session. id_token applies to user grants, refresh_token only offline_access. client_id body required unless derived from Basic auth. Current source uses Nest default HTTP 201 for successful POST. This is a compatibility finding, not a statement of OAuth compliance.

Аутентификация: Правила клиента endpoint / clientBasic

request

request — oneOf Вариант 1

ПолеТипОбязательно у родителяОграничения / описание
client_idstringНет
client_secretstringНет
grant_type“authorization_code”Да
codestringДа
redirect_uristringДаformat: “uri”
code_verifierstringДа

request — oneOf Вариант 2

ПолеТипОбязательно у родителяОграничения / описание
client_idstringНет
client_secretstringНет
grant_type“refresh_token”Да
refresh_tokenstringДа

request — oneOf Вариант 3

ПолеТипОбязательно у родителяОграничения / описание
client_idstringНет
client_secretstringНет
grant_type“client_credentials”Да
scopestringНет

request — oneOf Вариант 4

ПолеТипОбязательно у родителяОграничения / описание
client_idstringНет
client_secretstringНет
grant_type“urn:ietf:params:oauth:grant-type:device_code”Да
device_codestringДа
HTTPЗначение
201Токен выдан
400Некорректные параметры
401Неверный клиент, учётные данные, токен или grant
429Превышена частота запросов

response.201

ПолеТипОбязательно у родителяОграничения / описание
access_tokenstringДа
token_type“Bearer”Да
expires_inintegerДаminimum: 1
scopestringДа
id_tokenstringНет
refresh_tokenstringНет

response.400

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.400.message

response.400.message — oneOf Вариант 1

Тип: string.

response.400.message — oneOf Вариант 2

response.400.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

response.401

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.401.message

response.401.message — oneOf Вариант 1

Тип: string.

response.401.message — oneOf Вариант 2

response.401.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

response.429

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.429.message

response.429.message — oneOf Вариант 1

Тип: string.

response.429.message — oneOf Вариант 2

response.429.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

Device Authorization

Restricted to FIRST_PARTY, MIX Account mode, and explicitly enabled device grant. Not available to general third-party apps. Current source uses Nest default HTTP 201 for successful POST. This is a compatibility finding, not a statement of OAuth compliance.

Аутентификация: Правила клиента endpoint / clientBasic

request

ПолеТипОбязательно у родителяОграничения / описание
client_idstringНет
client_secretstringНет
scopestringНет
HTTPЗначение
201Авторизация устройства создана
400Некорректные параметры
401Неверный клиент, учётные данные, токен или grant
429Превышена частота запросов

response.201

ПолеТипОбязательно у родителяОграничения / описание
device_codestringДа
user_codestringДа
verification_uristringДаformat: “uri”
verification_uri_completestringДаformat: “uri”
expires_in600Да
interval5Да

response.400

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.400.message

response.400.message — oneOf Вариант 1

Тип: string.

response.400.message — oneOf Вариант 2

response.400.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

response.401

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.401.message

response.401.message — oneOf Вариант 1

Тип: string.

response.401.message — oneOf Вариант 2

response.401.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

response.429

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.429.message

response.429.message — oneOf Вариант 1

Тип: string.

response.429.message — oneOf Вариант 2

response.429.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

Профиль по user access token и scopes

Аутентификация: bearer

HTTPЗначение
200Успешный ответ
400Некорректные параметры
401Неверный клиент, учётные данные, токен или grant
429Превышена частота запросов

response.200

ПолеТипОбязательно у родителяОграничения / описание
substringДа
namestring / nullНет
emailstringНет
email_verifiedbooleanНет

response.400

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.400.message

response.400.message — oneOf Вариант 1

Тип: string.

response.400.message — oneOf Вариант 2

response.400.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

response.401

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.401.message

response.401.message — oneOf Вариант 1

Тип: string.

response.401.message — oneOf Вариант 2

response.401.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

response.429

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.429.message

response.429.message — oneOf Вариант 1

Тип: string.

response.429.message — oneOf Вариант 2

response.429.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

Introspection

Confidential client required. Non-first-party caller must match token audience. Invalid/expired/inactive token returns active:false. Current source uses Nest default HTTP 201 for successful POST. This is a compatibility finding, not a statement of OAuth compliance. client_secret_post is represented by client_id/client_secret form fields; HTTP Basic alternative is described by security scheme. The empty security alternative is valid only with authenticated client_id/client_secret form fields; anonymous requests are rejected.

Аутентификация: clientBasic / Правила клиента endpoint

request

ПолеТипОбязательно у родителяОграничения / описание
client_idstringНет
client_secretstringНет
tokenstringДа
HTTPЗначение
201Результат проверки токена
400Некорректные параметры
401Неверный клиент, учётные данные, токен или grant
429Превышена частота запросов

response.201

ПолеТипОбязательно у родителяОграничения / описание
activebooleanДа
substringНет
audСм. вариантыНет
scopestringНет
expintegerНет
iatintegerНет
token_type“Bearer”Нет
token_usestringНет

response.201.aud

response.201.aud — oneOf Вариант 1

Тип: string.

response.201.aud — oneOf Вариант 2

response.201.aud — oneOf Вариант 2[] (Элемент массива)

Тип: string.

response.400

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.400.message

response.400.message — oneOf Вариант 1

Тип: string.

response.400.message — oneOf Вариант 2

response.400.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

response.401

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.401.message

response.401.message — oneOf Вариант 1

Тип: string.

response.401.message — oneOf Вариант 2

response.401.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

response.429

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.429.message

response.429.message — oneOf Вариант 1

Тип: string.

response.429.message — oneOf Вариант 2

response.429.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

Отзыв токена

Confidential client required in current source. Unknown token is handled idempotently; this profile is not a generic revocation route for public clients. Current source uses Nest default HTTP 201 for successful POST. This is a compatibility finding, not a statement of OAuth compliance. client_secret_post is represented by client_id/client_secret form fields; HTTP Basic alternative is described by security scheme. The empty security alternative is valid only with authenticated client_id/client_secret form fields; anonymous requests are rejected.

Аутентификация: clientBasic / Правила клиента endpoint

request

ПолеТипОбязательно у родителяОграничения / описание
client_idstringНет
client_secretstringНет
tokenstringДа
HTTPЗначение
201Токен отозван
400Некорректные параметры
401Неверный клиент, учётные данные, токен или grant
429Превышена частота запросов

response.201

Тип: object.

response.400

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.400.message

response.400.message — oneOf Вариант 1

Тип: string.

response.400.message — oneOf Вариант 2

response.400.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

response.401

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.401.message

response.401.message — oneOf Вариант 1

Тип: string.

response.401.message — oneOf Вариант 2

response.401.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

response.429

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.429.message

response.429.message — oneOf Вариант 1

Тип: string.

response.429.message — oneOf Вариант 2

response.429.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

Выход по ID token hint

Аутентификация: Security scheme не задана; правила клиента/flow всё равно могут применяться.

ИмяГдеТипОбязательноОграничения
id_token_hintquerystringДа
post_logout_redirect_uriquerystringНетformat: “uri”
HTTPЗначение
204Сессия отозвана без перенаправления
302Перенаправление на зарегистрированный URI
400Некорректные параметры
401Неверный клиент, учётные данные, токен или grant
429Превышена частота запросов

response.400

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.400.message

response.400.message — oneOf Вариант 1

Тип: string.

response.400.message — oneOf Вариант 2

response.400.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

response.401

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.401.message

response.401.message — oneOf Вариант 1

Тип: string.

response.401.message — oneOf Вариант 2

response.401.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.

response.429

ПолеТипОбязательно у родителяОграничения / описание
statusCodeintegerДа
messageСм. вариантыДа
errorstringНет

response.429.message

response.429.message — oneOf Вариант 1

Тип: string.

response.429.message — oneOf Вариант 2

response.429.message — oneOf Вариант 2[] (Элемент массива)

Тип: string.