Pereiti prie turinio
Sursa Developers

POST/oauth/token

Išduoti OAuth 2.0 žetoną

oauth_token

OAuth 2.0 žetonų operacija (RFC 6749, 3.2 skirsnis). grant_type: authorization_code iškeičia vienkartinį kodą į žetonų porą ir reikalauja code_verifier (PKCE S256); refresh_token išduoda naują porą už atnaujinimo žetoną ir panaikina ankstesnio atnaujinimo žetono galiojimą (rotacija), o pakartotinai panaudojus negaliojantį žetoną atšaukiama visa grandinė; client_credentials išduoda žetoną organizacijos vardu, tik confidential programai, be atnaujinimo žetono. confidential klientas tapatybę patvirtina antrašte Authorization: Basic arba laukais client_id ir client_secret; viešasis klientas siunčia tik client_id. Prieigos žetonas galioja 1 valandą, atnaujinimo žetonas – 90 dienų. Atsakai ir klaidos atitinka RFC 6749 5 skirsnį, su Cache-Control: no-store. Pridėta 1.62.0 versijoje.

Autentifikavimas

Prisijungimo duomenų nereikia.

Užklausos turinys

application/x-www-form-urlencoded

Objektas: OAuthTokenRequest

  • grant_typestringprivalomas

    Leidžiamos reikšmės: authorization_coderefresh_tokenclient_credentials

  • codestring

    Autorizacijos kodas (authorization_code).

  • redirect_uristring

    Tas pats peradresavimo URI, kaip autorizacijos užklausoje (authorization_code).

  • code_verifierstring

    Pradinė PKCE reikšmė, nuo 43 iki 128 simbolių (authorization_code).

  • refresh_tokenstring

    Atnaujinimas (refresh_token).

  • scopestring

    Tarpais atskirtos apimtys, tik siaurinančios (refresh_token, client_credentials).

  • client_idstring

    Programos ID, kai paslaptis neperduodama antraštėje Authorization: Basic.

  • client_secretstring

    confidential programos kliento paslaptis, kai ji neperduodama antraštėje Authorization: Basic.

Atsakai

200Žetonai išduoti.

Atsako antraštės

  • RateLimit-Policy

    Galiojantys limitai IETF juodraščio draft-ietf-httpapi-ratelimit-headers formatu: kableliais atskirti elementai "<name>";q=<quota>;w=<window in seconds>. key – API rakto užklausų dažnis (kvota – pliūpsnis, laiko langas – laikas, per kurį kvota visiškai atsistato; sesijai tai user, be prisijungimo duomenų – ip); minute, day ir month – organizacijos kvotos kalendorinei minutei, dienai ir mėnesiui pagal UTC.

  • RateLimit

    Kiek liko kiekvieno RateLimit-Policy limito: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Griežčiausio RateLimit-Policy įrašo (kuriame liko mažiausiai užklausų) limitas.

  • X-RateLimit-Remaining

    Likusių užklausų skaičius pagal griežčiausią limitą.

  • X-RateLimit-Reset

    Sekundės iki griežčiausio limito atsistatymo.

application/json

Objektas: OAuthTokenResponse

  • access_tokenstringprivalomas

    Prieigos žetonas (kbat_…) antraštei Authorization: Bearer.

  • token_typestringprivalomas

    Leidžiamos reikšmės: Bearer

  • expires_inintegerprivalomas

    Prieigos žetono galiojimo trukmė sekundėmis.

  • refresh_tokenstring

    Atnaujinimo žetonas (kbrt_…); kliento prisijungimo duomenų (client credentials) atveju jo nėra.

  • scopestringprivalomas

    Tarpais atskirtos žetono apimtys.

400Klaida, kaip apibrėžta RFC 6749 5.2 skirsnyje.

Atsako antraštės

  • RateLimit-Policy

    Galiojantys limitai IETF juodraščio draft-ietf-httpapi-ratelimit-headers formatu: kableliais atskirti elementai "<name>";q=<quota>;w=<window in seconds>. key – API rakto užklausų dažnis (kvota – pliūpsnis, laiko langas – laikas, per kurį kvota visiškai atsistato; sesijai tai user, be prisijungimo duomenų – ip); minute, day ir month – organizacijos kvotos kalendorinei minutei, dienai ir mėnesiui pagal UTC.

  • RateLimit

    Kiek liko kiekvieno RateLimit-Policy limito: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Griežčiausio RateLimit-Policy įrašo (kuriame liko mažiausiai užklausų) limitas.

  • X-RateLimit-Remaining

    Likusių užklausų skaičius pagal griežčiausią limitą.

  • X-RateLimit-Reset

    Sekundės iki griežčiausio limito atsistatymo.

application/json

Objektas: OAuthErrorResponse

401Netinkami kliento prisijungimo duomenys (`invalid_client`).

Atsako antraštės

  • RateLimit-Policy

    Galiojantys limitai IETF juodraščio draft-ietf-httpapi-ratelimit-headers formatu: kableliais atskirti elementai "<name>";q=<quota>;w=<window in seconds>. key – API rakto užklausų dažnis (kvota – pliūpsnis, laiko langas – laikas, per kurį kvota visiškai atsistato; sesijai tai user, be prisijungimo duomenų – ip); minute, day ir month – organizacijos kvotos kalendorinei minutei, dienai ir mėnesiui pagal UTC.

  • RateLimit

    Kiek liko kiekvieno RateLimit-Policy limito: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Griežčiausio RateLimit-Policy įrašo (kuriame liko mažiausiai užklausų) limitas.

  • X-RateLimit-Remaining

    Likusių užklausų skaičius pagal griežčiausią limitą.

  • X-RateLimit-Reset

    Sekundės iki griežčiausio limito atsistatymo.

application/json

Objektas: OAuthErrorResponse

Saugūs pakartojimai

Su kiekviena POST ir PATCH užklausa siųskite antraštę Idempotency-Key (pavyzdžiui, UUID). Pakartojus užklausą su tuo pačiu raktu per 24 valandas, grąžinamas išsaugotas atsakas, o užklausa iš naujo nevykdoma.

Užklausų dažnio limitai

Atsakuose yra antraštės RateLimit ir RateLimit-Policy bei ankstesnės X-RateLimit-Limit, X-RateLimit-Remaining ir X-RateLimit-Reset. Atsake 429 yra antraštė Retry-After sekundėmis: palaukite ir pakartokite užklausą.

← oauth · API žinynas