Pāriet uz saturu
Sursa Developers

POST/oauth/token

Izsniegt OAuth 2.0 marķieri

oauth_token

OAuth 2.0 marķieru operācija (RFC 6749, 3.2. sadaļa). grant_type: authorization_code apmaina vienreizēju kodu pret marķieru pāri un prasa code_verifier (PKCE S256); refresh_token izsniedz jaunu pāri pret atsvaidzināšanas marķieri un padara iepriekšējo atsvaidzināšanas marķieri nederīgu (rotācija), bet nederīga marķiera atkārtota izmantošana atsauc visu ķēdi; client_credentials izsniedz marķieri organizācijas vārdā, tikai lietotnei confidential, bez atsvaidzināšanas marķiera. Klients confidential autentificējas ar galveni Authorization: Basic vai ar laukiem client_id un client_secret; publisks klients nosūta tikai client_id. Piekļuves marķieris ir derīgs 1 stundu, atsvaidzināšanas marķieris – 90 dienas. Atbildes un kļūdas atbilst RFC 6749 5. sadaļai, ar Cache-Control: no-store. Pievienots versijā 1.62.0.

Autentifikācija

Akreditācijas dati nav vajadzīgi.

Pieprasījuma saturs

application/x-www-form-urlencoded

Objekts: OAuthTokenRequest

  • grant_typestringobligāts

    Atļautās vērtības: authorization_coderefresh_tokenclient_credentials

  • codestring

    Autorizācijas kods (authorization_code).

  • redirect_uristring

    Tas pats novirzīšanas URI, kas autorizācijas pieprasījumā (authorization_code).

  • code_verifierstring

    Sākotnējā PKCE vērtība, no 43 līdz 128 rakstzīmēm (authorization_code).

  • refresh_tokenstring

    Atsvaidzināšanas marķieris (refresh_token).

  • scopestring

    Ar atstarpēm atdalīti tvērumi, tikai sašaurināšanai (refresh_token, client_credentials).

  • client_idstring

    Lietotnes ID, ja noslēpums netiek nodots galvenē Authorization: Basic.

  • client_secretstring

    confidential lietotnes klienta noslēpums, ja tas netiek nodots galvenē Authorization: Basic.

Atbildes

200Marķieri izsniegti.

Atbildes galvenes

  • RateLimit-Policy

    Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.

  • RateLimit

    Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).

  • X-RateLimit-Remaining

    Atlikušo pieprasījumu skaits stingrākā limita ietvaros.

  • X-RateLimit-Reset

    Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: OAuthTokenResponse

  • access_tokenstringobligāts

    Piekļuves marķieris (kbat_…) galvenei Authorization: Bearer.

  • token_typestringobligāts

    Atļautās vērtības: Bearer

  • expires_inintegerobligāts

    Piekļuves marķiera derīguma ilgums sekundēs.

  • refresh_tokenstring

    Atsvaidzināšanas marķieris (kbrt_…); klienta akreditācijas datiem tā nav.

  • scopestringobligāts

    Ar atstarpēm atdalīti marķiera tvērumi.

400Kļūda, kā noteikts RFC 6749 5.2. sadaļā.

Atbildes galvenes

  • RateLimit-Policy

    Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.

  • RateLimit

    Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).

  • X-RateLimit-Remaining

    Atlikušo pieprasījumu skaits stingrākā limita ietvaros.

  • X-RateLimit-Reset

    Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: OAuthErrorResponse

401Nederīgi klienta akreditācijas dati (`invalid_client`).

Atbildes galvenes

  • RateLimit-Policy

    Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.

  • RateLimit

    Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).

  • X-RateLimit-Remaining

    Atlikušo pieprasījumu skaits stingrākā limita ietvaros.

  • X-RateLimit-Reset

    Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: OAuthErrorResponse

Droši atkārtojumi

Ar katru POST un PATCH pieprasījumu nosūtiet galveni Idempotency-Key (piemēram, UUID). Atkārtots pieprasījums ar to pašu atslēgu 24 stundu laikā atgriež saglabāto atbildi, nevis izpilda pieprasījumu vēlreiz.

Pieprasījumu biežuma limiti

Atbildēs ir galvenes RateLimit un RateLimit-Policy, kā arī agrākās X-RateLimit-Limit, X-RateLimit-Remaining un X-RateLimit-Reset. Atbildē 429 ir galvene Retry-After sekundēs: nogaidiet un atkārtojiet pieprasījumu.

← oauth · API rokasgrāmata