Skip to main content
Izmantojiet OAuth klienta akreditācijas datus, ja jūsu aizmugursistēmas integrācijai ir nepieciešami īslaicīgi piekļuves tokeni vai to pieprasa jūsu drošības politika. Katrs klients pieder vienam pakalpojuma kontam un vienai organizācijai. OAuth nav obligāts: privātai servera integrācijai, kas spēj droši glabāt un rotēt atslēgu, pietiek ar ierobežota apjoma API atslēgu. Skatiet Authentication, lai izvēlētos starp abām metodēm un izprastu, kā tajās iekļaujas pakalpojumu konti.
Jūsu organizācijai ir jābūt iespējotai OAuth piekļuvei. Iestatīšanas laikā tiek nodrošināts reģionālais tokenu galapunkts, izdevējs, mērķauditorija un klienta autentifikācijas metode. Ja jums ir nepieciešami šie iestatījumi vai nevarat piekļūt klientu pārvaldībai, sazinieties ar Living Security atbalsta dienestu.
Klienta akreditācijas datu piešķīrums (client credentials grant) pārstāv jūsu pakalpojuma kontu. Tas nepierakstīta personu un neprasa klientam autorizēt lietojumprogrammu. Deleģētā autorizācija, izmantojot pārlūkprogrammu, ir atsevišķa OAuth iespēja, un šīs darbības to nenodrošina.

Pirms sākat

  • Izveidojiet pakalpojuma kontu tikai ar tām atļaujām, kas nepieciešamas integrācijai.
  • Izmantojiet pārvaldības akreditācijas datus ar service_account:manage un katru atļauju, ko vēlaties piešķirt jaunajam klientam. Mērķa kontam ir jābūt arī šīm atļaujām. Klients nevar paplašināt neviena konta pilnvaras.
  • Izvēlieties organizācijas reģionu. API akreditācijas dati un OAuth piekļuves tokeni attiecas uz atbilstošo reģionālo API resursdatoru.
  • Glabājiet klienta noslēpumu un tokenus savā servera puses noslēpumu krātuvē. Nekad neievietojiet tos pārlūkprogrammas kodā, mobilajās lietojumprogrammās, versiju kontrolē vai pieprasījumu žurnālos.

Klienta izveide

POST /v1/oauth_clients nepieciešams service_account_id, netukšs skaidri norādīta scopes saraksts un Idempotency-Key. Aizstājējzīmes netiek pieņemtas. Klients atbalsta līdz 100 darbības jomām (scopes) ar kopējo garumu ne vairāk kā 4 096 rakstzīmes. Katram pakalpojuma kontam var būt ne vairāk kā 20 klientu vai neatrisinātu izveides/tīrīšanas darbību. Atsaukšana nekavējoties liedz piekļuvi API. Klients vai neskaidra pakalpojumu sniedzēja puses izveide turpina ieskaitīties limitā, līdz ir apstiprināta attālā tīrīšana. Pamesta rezervācija vai izveide, par kuru pierādīts, ka tā neizdevās pirms pakalpojumu sniedzēja darbības sākuma, var droši atbrīvot savu vietu. Tās atkārtošanas atslēga joprojām pieder sākotnējam mēģinājumam; pirms izlemjat izveidot aizstājēju, atgūstiet šo kvīti. Izvēlieties vienu atkārtošanas atslēgu šim izveides mēģinājumam un saglabājiet to pirms pieprasījuma nosūtīšanas. Izmantojiet 1–255 redzamas ASCII rakstzīmes bez atstarpēm. Izmantojiet to atkārtoti ar to pašu kontu, darbības jomām, pārvaldības principālu, reģionu un API versiju pēc zaudētas atbildes. Pārvaldības akreditācijas datu rotēšana zem tā paša pakalpojuma konta neveido jaunu atkārtošanas identitāti. Instalējiet Python pakotni requests. Ielādējiet turpmākās vides vērtības, izmantojot savu ierasto noslēpumu un konfigurācijas pārvaldību:
Python
Piemērs veic vienu pieprasījumu un glabā rezultātu atmiņā. Pirms izmantošanas produkcijā norādītajā vietā pievienojiet sava noslēpumu pārvaldnieka rakstīšanas darbību. Piemērs apzināti pieprasa lēmumu pēc neskaidra rezultāta, nevis klusi izveido citu klientu. Arī tīkla izņēmumiem nepieciešamas tālāk aprakstītās atgūšanas darbības. Izveides un kvīts atbildēs tiek izmantots 201, un tās satur oauth_client resursu ar id, service_account_id, client_id, scopes, status, created_at un client_secret. Atbildes ir atzīmētas ar Cache-Control: no-store.
  • id identificē platformas resursu. Saglabājiet to iegūšanai un atsaukšanai.
  • client_id identificē klientu tokenu apmaiņas laikā. Tas nav platformas resursa ID. Kamēr izveide ir nepabeigta, tas var būt null.
  • client_secret tiek atgriezts tikai tam pieprasījumam, kas pabeidz izveidi. Katrs atkārtots izveides pieprasījums atgriež null, tostarp atkārtojums pēc zaudētas veiksmīgas atbildes. Iegūšana nekad neatgriež noslēpumu.

Zaudētas vai pārtrauktas atbildes atgūšana

Atkārtojiet to pašu izveides pieprasījumu ar saglabāto atkārtošanas atslēgu, lai atgūtu resursa kvīti. Kvīts atspoguļo pašreizējo stāvokli, tāpēc atsauktais klients paliek atsaukts. Šī darbība neizmanto vispārējo 24 stundu kešatmiņā saglabāto atbilžu atkārtošanas līgumu un neatgriež Idempotent-Replayed galveni. Informāciju par pieprasījumu ID un atgūšanu skatiet sadaļā errors. Nekad nesūtiet klienta noslēpumu vai piekļuves tokenu kopā ar atbalsta pieprasījumu.

Pārbaude un atsaukšana

Izmantojiet savus pārvaldības akreditācijas datus un platformas resursa id: Atsaukšana bloķē turpmākos klienta API pieprasījumus, tostarp pieprasījumus ar jau izsniegtiem tokeniem. Tā neatceļ darbu, ko API jau ir pieņēmis. Attālā akreditācijas datu tīrīšana var tikt pabeigta vēlāk. Atsaukšanas atkārtošana ir droša un neprasa atkārtošanas atslēgu. Turpiniet izmantot pārvaldības akreditācijas datus, ja atsaucamais klients pats ir API izsaucējs.

Rotēšana bez piekļuves zaudēšanas

Izveidojiet otru klientu ar nepieciešamo darbības jomu augšējo robežu. Saglabājiet tā noslēpumu, iegūstiet tokenu, izmantojot savu reģionālo tokenu galapunktu, un pārbaudiet, vai integrācija ar to darbojas. Pārslēdziet integrāciju uz aizstājēju, pēc tam atsauciet veco resursu. Saglabājiet neatkarīgus pārvaldības akreditācijas datus, lai varētu atgūties no neveiksmīgas ieviešanas. Piekļuves tokeni nevar piešķirt vairāk, nekā atļauj klienta darbības jomas un pakalpojuma konta pašreizējās atļaujas. Konta atļauju noņemšana vai klienta atsaukšana ir svarīgāka par tokena atlikušo derīguma laiku. Neuzskatiet kešatmiņā saglabātu tokenu par pierādījumu, ka autorizācija joprojām ir spēkā. Jaunu piekļuves tokenu iegūstiet pirms derīguma beigām, atkārtoti autentificējot klientu; šis piešķīrums neizmanto atsvaidzināšanas tokenus.