Siirry sisältöön
Sursa Developers

POST/oauth/token

Myönnä OAuth 2.0 -tunnus

oauth_token

OAuth 2.0:n tunnusten myöntöpäätepiste (RFC 6749, kohta 3.2). grant_type: authorization_code vaihtaa kertakäyttöisen koodin tunnuspariin ja edellyttää code_verifier-arvoa (PKCE S256); refresh_token myöntää päivitystunnukselle uuden parin ja mitätöi edellisen päivitystunnuksen (uusiminen), ja mitätöidyn päivitystunnuksen uudelleenkäyttö peruu koko ketjun; client_credentials myöntää käyttöoikeustunnuksen organisaation puolesta, vain confidential-sovellukselle, ilman päivitystunnusta. confidential-asiakasohjelma todentaa itsensä Authorization: Basic -otsakkeella tai client_id- ja client_secret-kentillä; julkinen asiakasohjelma lähettää vain client_id-arvon. Käyttöoikeustunnus on voimassa 1 tunnin, päivitystunnus 90 päivää. Vastaukset ja virheet noudattavat RFC 6749:n kohtaa 5, ja niissä on Cache-Control: no-store. Lisätty versiossa 1.62.0.

Todennus

Tunnistetietoja ei tarvita.

Pyynnön runko

application/x-www-form-urlencoded

Objekti: OAuthTokenRequest

  • grant_typestringpakollinen

    Sallitut arvot: authorization_coderefresh_tokenclient_credentials

  • codestring

    Valtuutuskoodi (authorization_code).

  • redirect_uristring

    Sama uudelleenohjaus-URI kuin valtuutuspyynnössä (authorization_code).

  • code_verifierstring

    Alkuperäinen PKCE-arvo, 43–128 merkkiä (authorization_code).

  • refresh_tokenstring

    Päivitys (refresh_token).

  • scopestring

    Välilyönnein erotetut käyttöalueet, vain kaventaminen (refresh_token, client_credentials).

  • client_idstring

    Sovelluksen tunnus, kun salaisuutta ei välitetä Authorization: Basic-otsakkeessa.

  • client_secretstring

    confidential-sovelluksen asiakassalaisuus, kun sitä ei välitetä Authorization: Basic-otsakkeessa.

Vastaukset

200Tunnukset myönnettiin.

Vastausotsakkeet

  • RateLimit-Policy

    Voimassa olevat rajat IETF-luonnoksen draft-ietf-httpapi-ratelimit-headers muodossa: pilkuin erotetut kohteet "<name>";q=<quota>;w=<window in seconds>. key on API-avaimen pyyntönopeus (kiintiö on purske, aikaikkuna on aika, jossa se täyttyy kokonaan; istunnolle se on user, ilman tunnistetietoja ip); minute, day ja month ovat organisaation kiintiöt UTC-ajan kalenteriminuutille, -päivälle ja -kuukaudelle.

  • RateLimit

    Mitä kustakin RateLimit-Policy-otsakkeen rajasta on jäljellä: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    RateLimit-Policy-otsakkeen tiukimman kohteen raja (sen, jossa pyyntöjä on jäljellä vähiten).

  • X-RateLimit-Remaining

    Tiukimman rajan puitteissa jäljellä olevat pyynnöt.

  • X-RateLimit-Reset

    Sekunteja siihen, kun tiukin raja nollautuu.

application/json

Objekti: OAuthTokenResponse

  • access_tokenstringpakollinen

    Käyttöoikeustunnus (kbat_…) Authorization: Bearer-otsaketta varten.

  • token_typestringpakollinen

    Sallitut arvot: Bearer

  • expires_inintegerpakollinen

    Käyttöoikeustunnuksen voimassaoloaika sekunteina.

  • refresh_tokenstring

    Päivitystunnus (kbrt_…); puuttuu client credentials -myöntötyypissä.

  • scopestringpakollinen

    Käyttöoikeustunnuksen käyttöalueet välilyönnein erotettuina.

400Virhe RFC 6749:n kohdan 5.2 mukaisesti.

Vastausotsakkeet

  • RateLimit-Policy

    Voimassa olevat rajat IETF-luonnoksen draft-ietf-httpapi-ratelimit-headers muodossa: pilkuin erotetut kohteet "<name>";q=<quota>;w=<window in seconds>. key on API-avaimen pyyntönopeus (kiintiö on purske, aikaikkuna on aika, jossa se täyttyy kokonaan; istunnolle se on user, ilman tunnistetietoja ip); minute, day ja month ovat organisaation kiintiöt UTC-ajan kalenteriminuutille, -päivälle ja -kuukaudelle.

  • RateLimit

    Mitä kustakin RateLimit-Policy-otsakkeen rajasta on jäljellä: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    RateLimit-Policy-otsakkeen tiukimman kohteen raja (sen, jossa pyyntöjä on jäljellä vähiten).

  • X-RateLimit-Remaining

    Tiukimman rajan puitteissa jäljellä olevat pyynnöt.

  • X-RateLimit-Reset

    Sekunteja siihen, kun tiukin raja nollautuu.

application/json

Objekti: OAuthErrorResponse

401Virheelliset asiakasohjelman tunnistetiedot (`invalid_client`).

Vastausotsakkeet

  • RateLimit-Policy

    Voimassa olevat rajat IETF-luonnoksen draft-ietf-httpapi-ratelimit-headers muodossa: pilkuin erotetut kohteet "<name>";q=<quota>;w=<window in seconds>. key on API-avaimen pyyntönopeus (kiintiö on purske, aikaikkuna on aika, jossa se täyttyy kokonaan; istunnolle se on user, ilman tunnistetietoja ip); minute, day ja month ovat organisaation kiintiöt UTC-ajan kalenteriminuutille, -päivälle ja -kuukaudelle.

  • RateLimit

    Mitä kustakin RateLimit-Policy-otsakkeen rajasta on jäljellä: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    RateLimit-Policy-otsakkeen tiukimman kohteen raja (sen, jossa pyyntöjä on jäljellä vähiten).

  • X-RateLimit-Remaining

    Tiukimman rajan puitteissa jäljellä olevat pyynnöt.

  • X-RateLimit-Reset

    Sekunteja siihen, kun tiukin raja nollautuu.

application/json

Objekti: OAuthErrorResponse

Turvalliset uusintayritykset

Lähetä jokaisen POST- ja PATCH-pyynnön mukana Idempotency-Key-otsake (esimerkiksi UUID). Kun pyyntö toistetaan samalla avaimella 24 tunnin kuluessa, palautetaan tallennettu vastaus eikä pyyntöä suoriteta uudelleen.

Nopeusrajoitukset

Vastauksissa ovat RateLimit- ja RateLimit-Policy-otsakkeet sekä aiemmat X-RateLimit-Limit, X-RateLimit-Remaining ja X-RateLimit-Reset. 429-vastauksessa on Retry-After sekunteina: odota ja yritä uudelleen.

← oauth · API-viite