Przejdź do treści
Sursa Developers

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

Pobieranie metadanych serwera autoryzacji

get_oauth_server_metadata

Metadane serwera autoryzacji OAuth 2.0 (RFC 8414): issuer to adres główny instalacji, strona zgody znajduje się na adresie głównym, a punkty końcowe wydawania i unieważniania tokenów – na adresie API, jeśli jest ustawiony. Zawiera obsługiwane typy przyznania (grant types), metody PKCE, metody uwierzytelniania klienta i zakresy. Dodano w wersji 1.62.0.

Uwierzytelnianie

Dane uwierzytelniające nie są potrzebne.

Odpowiedzi

200Pomyślna odpowiedź

Nagłówki odpowiedzi

  • RateLimit-Policy

    Obowiązujące limity w formacie projektu IETF draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami "<name>";q=<quota>;w=<window in seconds>. key to częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest to user, bez danych uwierzytelniających ip); minute, day i month to przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.

  • RateLimit

    Co pozostało z każdego limitu w RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit najbardziej restrykcyjnej pozycji w RateLimit-Policy (tej, w której zostało najmniej żądań).

  • X-RateLimit-Remaining

    Liczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.

  • X-RateLimit-Reset

    Liczba sekund do odnowienia najbardziej restrykcyjnego limitu.

application/json

Obiekt: OAuthServerMetadata

  • issuerstringwymagane
  • authorization_endpointstringwymagane
  • token_endpointstringwymagane
  • revocation_endpointstringwymagane
  • response_types_supportedarray of stringwymagane
  • grant_types_supportedarray of stringwymagane
  • code_challenge_methods_supportedarray of stringwymagane
  • token_endpoint_auth_methods_supportedarray of stringwymagane
  • revocation_endpoint_auth_methods_supportedarray of stringwymagane
  • scopes_supportedarray of stringwymagane
  • service_documentationstring

Limity częstotliwości

Odpowiedzi zawierają nagłówki RateLimit i RateLimit-Policy oraz starsze X-RateLimit-Limit, X-RateLimit-Remaining i X-RateLimit-Reset. Odpowiedź 429 ma nagłówek Retry-After w sekundach: odczekaj i ponów żądanie.

← oauth · Dokumentacja API