Перейти к содержанию
Sursa для разработчиков

GET/.well-known/oauth-authorization-server

Получить метаданные сервера авторизации

get_oauth_server_metadata

Метаданные сервера авторизации OAuth 2.0 (RFC 8414): issuer — основной адрес установки, страница согласия — на основном адресе, а конечные точки выдачи и отзыва токенов — на адресе API, если он задан. Перечисляет поддерживаемые типы выдачи (grant types), методы PKCE, методы аутентификации клиента и области доступа. Добавлено в 1.62.0.

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

Учётные данные не нужны.

Ответы

200Успешный ответ

Заголовки ответа

  • RateLimit-Policy

    Действующие лимиты в формате черновика IETF draft-ietf-httpapi-ratelimit-headers: элементы через запятую "<name>";q=<quota>;w=<window in seconds>. key — частота запросов ключа API (квота — допустимый всплеск, окно — время до полного восстановления; для сессии это user, без учётных данных — ip); minute, day и month — квоты организации на календарную минуту, день и месяц по UTC.

  • RateLimit

    Сколько осталось по каждому лимиту из RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Лимит самой строгой записи в RateLimit-Policy (той, где осталось меньше всего запросов).

  • X-RateLimit-Remaining

    Сколько запросов осталось в пределах самого строгого лимита.

  • X-RateLimit-Reset

    Через сколько секунд сбросится самый строгий лимит.

application/json

Объект: OAuthServerMetadata

  • issuerstringобязательно
  • authorization_endpointstringобязательно
  • token_endpointstringобязательно
  • revocation_endpointstringобязательно
  • response_types_supportedarray of stringобязательно
  • grant_types_supportedarray of stringобязательно
  • code_challenge_methods_supportedarray of stringобязательно
  • token_endpoint_auth_methods_supportedarray of stringобязательно
  • revocation_endpoint_auth_methods_supportedarray of stringобязательно
  • scopes_supportedarray of stringобязательно
  • service_documentationstring

Лимиты частоты

В ответах есть заголовки RateLimit и RateLimit-Policy, а также прежние X-RateLimit-Limit, X-RateLimit-Remaining и X-RateLimit-Reset. В ответе 429 есть Retry-After в секундах: подождите и повторите запрос.

← oauth · Справочник API