Preskočiť na obsah
Sursa Developers

POST/oauth/token

Vydať token OAuth 2.0

oauth_token

Koncový bod na vydávanie tokenov OAuth 2.0 (RFC 6749, oddiel 3.2). grant_type: authorization_code vymení jednorazový kód za dvojicu tokenov a vyžaduje code_verifier (PKCE S256); refresh_token vydá novú dvojicu za obnovovací token a zneplatní predchádzajúci obnovovací token (rotácia), pričom opätovné použitie zneplatneného tokenu odvolá celý reťazec; client_credentials vydá token v mene organizácie, len pre aplikáciu confidential a bez obnovovacieho tokenu. Klient confidential sa overuje hlavičkou Authorization: Basic alebo poliami client_id a client_secret; verejný klient posiela len client_id. Prístupový token platí 1 hodinu, obnovovací token 90 dní. Odpovede a chyby zodpovedajú RFC 6749, oddiel 5, s Cache-Control: no-store. Pridané vo verzii 1.62.0.

Autentifikácia

Prihlasovacie údaje nie sú potrebné.

Telo požiadavky

application/x-www-form-urlencoded

Objekt: OAuthTokenRequest

  • grant_typestringpovinné

    Povolené hodnoty: authorization_coderefresh_tokenclient_credentials

  • codestring

    Autorizačný kód (authorization_code).

  • redirect_uristring

    Rovnaké URI presmerovania ako v autorizačnej požiadavke (authorization_code).

  • code_verifierstring

    Pôvodná hodnota PKCE, 43 až 128 znakov (authorization_code).

  • refresh_tokenstring

    Obnovovací token (refresh_token).

  • scopestring

    Rozsahy oddelené medzerami, len na zúženie (refresh_token, client_credentials).

  • client_idstring

    ID aplikácie, keď sa tajný kľúč neodovzdáva v hlavičke Authorization: Basic.

  • client_secretstring

    Tajný kľúč klienta aplikácie confidential, keď sa neodovzdáva v hlavičke Authorization: Basic.

Odpovede

200Tokeny boli vydané.

Hlavičky odpovede

  • RateLimit-Policy

    Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.

  • RateLimit

    Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).

  • X-RateLimit-Remaining

    Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.

  • X-RateLimit-Reset

    Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: OAuthTokenResponse

  • access_tokenstringpovinné

    Prístupový token (kbat_…) pre hlavičku Authorization: Bearer.

  • token_typestringpovinné

    Povolené hodnoty: Bearer

  • expires_inintegerpovinné

    Doba platnosti prístupového tokenu v sekundách.

  • refresh_tokenstring

    Obnovovací token (kbrt_…); pri client credentials chýba.

  • scopestringpovinné

    Rozsahy tokenu oddelené medzerami.

400Chyba podľa RFC 6749, oddiel 5.2.

Hlavičky odpovede

  • RateLimit-Policy

    Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.

  • RateLimit

    Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).

  • X-RateLimit-Remaining

    Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.

  • X-RateLimit-Reset

    Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: OAuthErrorResponse

401Neplatné prihlasovacie údaje klienta (`invalid_client`).

Hlavičky odpovede

  • RateLimit-Policy

    Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.

  • RateLimit

    Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).

  • X-RateLimit-Remaining

    Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.

  • X-RateLimit-Reset

    Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: OAuthErrorResponse

Bezpečné opakovanie

S každou požiadavkou POST a PATCH odošlite hlavičku Idempotency-Key (napríklad UUID). Opakovaná požiadavka s rovnakým kľúčom do 24 hodín vráti uloženú odpoveď namiesto toho, aby sa požiadavka vykonala znova.

Limity frekvencie

Odpovede obsahujú hlavičky RateLimit a RateLimit-Policy a staršie X-RateLimit-Limit, X-RateLimit-Remaining a X-RateLimit-Reset. Odpoveď 429 má hlavičku Retry-After v sekundách: počkajte a požiadavku zopakujte.

← oauth · Referencia API