Mine sisu juurde
Sursa Developers

POST/oauth/token

OAuth 2.0 loa väljastamine

oauth_token

OAuth 2.0 lubade väljastamise lõpp-punkt (RFC 6749, jaotis 3.2). grant_type: authorization_code vahetab ühekordse koodi lubade paari vastu ja nõuab välja code_verifier (PKCE S256); refresh_token väljastab värskendusloa eest uue paari ja muudab eelmise värskendusloa kehtetuks (uuendamine) ning kehtetuks muudetud loa taaskasutamine tühistab kogu ahela; client_credentials väljastab loa organisatsiooni nimel, ainult confidential-rakendusele, ilma värskendusloata. confidential-klient autendib end päisega Authorization: Basic või väljadega client_id ja client_secret; avalik klient saadab ainult client_id. Juurdepääsuluba kehtib 1 tund, värskendusluba 90 päeva. Vastused ja vead järgivad RFC 6749 jaotist 5 koos päisega Cache-Control: no-store. Lisatud versioonis 1.62.0.

Autentimine

Autentimisandmeid pole vaja.

Päringu keha

application/x-www-form-urlencoded

Objekt: OAuthTokenRequest

  • grant_typestringkohustuslik

    Lubatud väärtused: authorization_coderefresh_tokenclient_credentials

  • codestring

    Autoriseerimiskood (authorization_code).

  • redirect_uristring

    Sama ümbersuunamise URI mis autoriseerimispäringus (authorization_code).

  • code_verifierstring

    Algne PKCE väärtus, 43 kuni 128 märki (authorization_code).

  • refresh_tokenstring

    Värskendamine (refresh_token).

  • scopestring

    Tühikutega eraldatud ulatused, ainult kitsendamiseks (refresh_token, client_credentials).

  • client_idstring

    Rakenduse ID, kui saladust ei edastata päises Authorization: Basic.

  • client_secretstring

    Rakenduse confidential kliendi saladus, kui seda ei edastata päises Authorization: Basic.

Vastused

200Load väljastati.

Vastuse päised

  • RateLimit-Policy

    Kehtivad piirangud IETF-i mustandi draft-ietf-httpapi-ratelimit-headers vormingus: komadega eraldatud elemendid "<name>";q=<quota>;w=<window in seconds>. key on API-võtme päringusagedus (kvoot on tipuvaru, ajaaken on aeg selle täielikuks taastumiseks; seansi puhul on see user, ilma autentimisandmeteta ip); minute, day ja month on organisatsiooni kvoodid kalendriminutile, -päevale ja -kuule UTC järgi.

  • RateLimit

    Iga päises RateLimit-Policy oleva piirangu jääk: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Päises RateLimit-Policy oleva rangeima kirje limiit (selle, millel on kõige vähem päringuid järel).

  • X-RateLimit-Remaining

    Rangeima piirangu järgi järelejäänud päringud.

  • X-RateLimit-Reset

    Sekundid rangeima piirangu lähtestumiseni.

application/json

Objekt: OAuthTokenResponse

  • access_tokenstringkohustuslik

    Juurdepääsuluba (kbat_…) päise Authorization: Bearer jaoks.

  • token_typestringkohustuslik

    Lubatud väärtused: Bearer

  • expires_inintegerkohustuslik

    Juurdepääsuloa eluiga sekundites.

  • refresh_tokenstring

    Värskendusluba (kbrt_…); client credentials puhul puudub.

  • scopestringkohustuslik

    Loa tühikutega eraldatud ulatused.

400Viga, nagu on määratletud RFC 6749 jaotises 5.2.

Vastuse päised

  • RateLimit-Policy

    Kehtivad piirangud IETF-i mustandi draft-ietf-httpapi-ratelimit-headers vormingus: komadega eraldatud elemendid "<name>";q=<quota>;w=<window in seconds>. key on API-võtme päringusagedus (kvoot on tipuvaru, ajaaken on aeg selle täielikuks taastumiseks; seansi puhul on see user, ilma autentimisandmeteta ip); minute, day ja month on organisatsiooni kvoodid kalendriminutile, -päevale ja -kuule UTC järgi.

  • RateLimit

    Iga päises RateLimit-Policy oleva piirangu jääk: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Päises RateLimit-Policy oleva rangeima kirje limiit (selle, millel on kõige vähem päringuid järel).

  • X-RateLimit-Remaining

    Rangeima piirangu järgi järelejäänud päringud.

  • X-RateLimit-Reset

    Sekundid rangeima piirangu lähtestumiseni.

application/json

Objekt: OAuthErrorResponse

401Vigased kliendi autentimisandmed (`invalid_client`).

Vastuse päised

  • RateLimit-Policy

    Kehtivad piirangud IETF-i mustandi draft-ietf-httpapi-ratelimit-headers vormingus: komadega eraldatud elemendid "<name>";q=<quota>;w=<window in seconds>. key on API-võtme päringusagedus (kvoot on tipuvaru, ajaaken on aeg selle täielikuks taastumiseks; seansi puhul on see user, ilma autentimisandmeteta ip); minute, day ja month on organisatsiooni kvoodid kalendriminutile, -päevale ja -kuule UTC järgi.

  • RateLimit

    Iga päises RateLimit-Policy oleva piirangu jääk: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Päises RateLimit-Policy oleva rangeima kirje limiit (selle, millel on kõige vähem päringuid järel).

  • X-RateLimit-Remaining

    Rangeima piirangu järgi järelejäänud päringud.

  • X-RateLimit-Reset

    Sekundid rangeima piirangu lähtestumiseni.

application/json

Objekt: OAuthErrorResponse

Turvalised korduskatsed

Saatke iga POST- ja PATCH-päringuga päis Idempotency-Key (näiteks UUID). Sama võtmega korduskatse 24 tunni jooksul tagastab salvestatud vastuse ega käivita päringut uuesti.

Sageduspiirangud

Vastustes on päised RateLimit ja RateLimit-Policy ning varasemad X-RateLimit-Limit, X-RateLimit-Remaining ja X-RateLimit-Reset. Vastuses 429 on päis Retry-After sekundites: oodake ja proovige uuesti.

← oauth · API teatmik