No Description
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

apiSpec.js 399KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", { value: true });
  3. exports.default = {
  4. openapi: "3.0.3",
  5. info: {
  6. title: "Identity Toolkit API",
  7. description: "The Google Identity Toolkit API lets you use open standards to verify a user's identity.",
  8. contact: { name: "Google", url: "https://google.com" },
  9. version: "v1",
  10. license: {
  11. name: "Creative Commons Attribution 3.0",
  12. url: "http://creativecommons.org/licenses/by/3.0/",
  13. },
  14. termsOfService: "https://developers.google.com/terms/",
  15. },
  16. servers: [{ url: "https://identitytoolkit.googleapis.com" }],
  17. externalDocs: { url: "https://cloud.google.com/identity-platform" },
  18. tags: [
  19. { name: "accounts" },
  20. { name: "projects" },
  21. { name: "v1" },
  22. { name: "defaultSupportedIdps" },
  23. { name: "secureToken" },
  24. { name: "emulator" },
  25. ],
  26. paths: {
  27. "/v1/accounts:createAuthUri": {
  28. post: {
  29. description: "If an email identifier is specified, checks and returns if any user account is registered with the email. If there is a registered account, fetches all providers associated with the account's email. If the provider ID of an Identity Provider (IdP) is specified, creates an authorization URI for the IdP. The user can be directed to this URI to sign in with the IdP. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
  30. operationId: "identitytoolkit.accounts.createAuthUri",
  31. responses: {
  32. "200": {
  33. description: "Successful response",
  34. content: {
  35. "*/*": {
  36. schema: {
  37. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1CreateAuthUriResponse",
  38. },
  39. },
  40. },
  41. },
  42. },
  43. requestBody: {
  44. content: {
  45. "application/json": {
  46. schema: {
  47. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1CreateAuthUriRequest",
  48. },
  49. },
  50. },
  51. },
  52. security: [
  53. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  54. { apiKeyQuery: [] },
  55. { apiKeyHeader: [] },
  56. ],
  57. tags: ["accounts"],
  58. },
  59. parameters: [
  60. { $ref: "#/components/parameters/access_token" },
  61. { $ref: "#/components/parameters/alt" },
  62. { $ref: "#/components/parameters/callback" },
  63. { $ref: "#/components/parameters/fields" },
  64. { $ref: "#/components/parameters/oauth_token" },
  65. { $ref: "#/components/parameters/prettyPrint" },
  66. { $ref: "#/components/parameters/quotaUser" },
  67. { $ref: "#/components/parameters/uploadType" },
  68. { $ref: "#/components/parameters/upload_protocol" },
  69. ],
  70. },
  71. "/v1/accounts:delete": {
  72. post: {
  73. description: "Deletes a user's account.",
  74. operationId: "identitytoolkit.accounts.delete",
  75. responses: {
  76. "200": {
  77. description: "Successful response",
  78. content: {
  79. "*/*": {
  80. schema: {
  81. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1DeleteAccountResponse",
  82. },
  83. },
  84. },
  85. },
  86. },
  87. requestBody: {
  88. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1DeleteAccountRequest",
  89. },
  90. security: [
  91. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  92. { apiKeyQuery: [] },
  93. { apiKeyHeader: [] },
  94. ],
  95. tags: ["accounts"],
  96. },
  97. parameters: [
  98. { $ref: "#/components/parameters/access_token" },
  99. { $ref: "#/components/parameters/alt" },
  100. { $ref: "#/components/parameters/callback" },
  101. { $ref: "#/components/parameters/fields" },
  102. { $ref: "#/components/parameters/oauth_token" },
  103. { $ref: "#/components/parameters/prettyPrint" },
  104. { $ref: "#/components/parameters/quotaUser" },
  105. { $ref: "#/components/parameters/uploadType" },
  106. { $ref: "#/components/parameters/upload_protocol" },
  107. ],
  108. },
  109. "/v1/accounts:issueSamlResponse": {
  110. post: {
  111. description: "Experimental",
  112. operationId: "identitytoolkit.accounts.issueSamlResponse",
  113. responses: {
  114. "200": {
  115. description: "Successful response",
  116. content: {
  117. "*/*": {
  118. schema: {
  119. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1IssueSamlResponseResponse",
  120. },
  121. },
  122. },
  123. },
  124. },
  125. requestBody: {
  126. content: {
  127. "application/json": {
  128. schema: {
  129. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1IssueSamlResponseRequest",
  130. },
  131. },
  132. },
  133. },
  134. security: [
  135. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  136. { apiKeyQuery: [] },
  137. { apiKeyHeader: [] },
  138. ],
  139. tags: ["accounts"],
  140. },
  141. parameters: [
  142. { $ref: "#/components/parameters/access_token" },
  143. { $ref: "#/components/parameters/alt" },
  144. { $ref: "#/components/parameters/callback" },
  145. { $ref: "#/components/parameters/fields" },
  146. { $ref: "#/components/parameters/oauth_token" },
  147. { $ref: "#/components/parameters/prettyPrint" },
  148. { $ref: "#/components/parameters/quotaUser" },
  149. { $ref: "#/components/parameters/uploadType" },
  150. { $ref: "#/components/parameters/upload_protocol" },
  151. ],
  152. },
  153. "/v1/accounts:lookup": {
  154. post: {
  155. description: "Gets account information for all matched accounts. For an end user request, retrieves the account of the end user. For an admin request with Google OAuth 2.0 credential, retrieves one or multiple account(s) with matching criteria.",
  156. operationId: "identitytoolkit.accounts.lookup",
  157. responses: {
  158. "200": {
  159. description: "Successful response",
  160. content: {
  161. "*/*": {
  162. schema: {
  163. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1GetAccountInfoResponse",
  164. },
  165. },
  166. },
  167. },
  168. },
  169. requestBody: {
  170. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1GetAccountInfoRequest",
  171. },
  172. security: [
  173. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  174. { apiKeyQuery: [] },
  175. { apiKeyHeader: [] },
  176. ],
  177. tags: ["accounts"],
  178. },
  179. parameters: [
  180. { $ref: "#/components/parameters/access_token" },
  181. { $ref: "#/components/parameters/alt" },
  182. { $ref: "#/components/parameters/callback" },
  183. { $ref: "#/components/parameters/fields" },
  184. { $ref: "#/components/parameters/oauth_token" },
  185. { $ref: "#/components/parameters/prettyPrint" },
  186. { $ref: "#/components/parameters/quotaUser" },
  187. { $ref: "#/components/parameters/uploadType" },
  188. { $ref: "#/components/parameters/upload_protocol" },
  189. ],
  190. },
  191. "/v1/accounts:resetPassword": {
  192. post: {
  193. description: "Resets the password of an account either using an out-of-band code generated by sendOobCode or by specifying the email and password of the account to be modified. Can also check the purpose of an out-of-band code without consuming it.",
  194. operationId: "identitytoolkit.accounts.resetPassword",
  195. responses: {
  196. "200": {
  197. description: "Successful response",
  198. content: {
  199. "*/*": {
  200. schema: {
  201. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1ResetPasswordResponse",
  202. },
  203. },
  204. },
  205. },
  206. },
  207. requestBody: {
  208. content: {
  209. "application/json": {
  210. schema: {
  211. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1ResetPasswordRequest",
  212. },
  213. },
  214. },
  215. },
  216. security: [
  217. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  218. { apiKeyQuery: [] },
  219. { apiKeyHeader: [] },
  220. ],
  221. tags: ["accounts"],
  222. },
  223. parameters: [
  224. { $ref: "#/components/parameters/access_token" },
  225. { $ref: "#/components/parameters/alt" },
  226. { $ref: "#/components/parameters/callback" },
  227. { $ref: "#/components/parameters/fields" },
  228. { $ref: "#/components/parameters/oauth_token" },
  229. { $ref: "#/components/parameters/prettyPrint" },
  230. { $ref: "#/components/parameters/quotaUser" },
  231. { $ref: "#/components/parameters/uploadType" },
  232. { $ref: "#/components/parameters/upload_protocol" },
  233. ],
  234. },
  235. "/v1/accounts:sendOobCode": {
  236. post: {
  237. description: "Sends an out-of-band confirmation code for an account. Requests from a authenticated request can optionally return a link including the OOB code instead of sending it.",
  238. operationId: "identitytoolkit.accounts.sendOobCode",
  239. responses: {
  240. "200": {
  241. description: "Successful response",
  242. content: {
  243. "*/*": {
  244. schema: {
  245. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1GetOobCodeResponse",
  246. },
  247. },
  248. },
  249. },
  250. },
  251. requestBody: {
  252. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1GetOobCodeRequest",
  253. },
  254. security: [
  255. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  256. { apiKeyQuery: [] },
  257. { apiKeyHeader: [] },
  258. ],
  259. tags: ["accounts"],
  260. },
  261. parameters: [
  262. { $ref: "#/components/parameters/access_token" },
  263. { $ref: "#/components/parameters/alt" },
  264. { $ref: "#/components/parameters/callback" },
  265. { $ref: "#/components/parameters/fields" },
  266. { $ref: "#/components/parameters/oauth_token" },
  267. { $ref: "#/components/parameters/prettyPrint" },
  268. { $ref: "#/components/parameters/quotaUser" },
  269. { $ref: "#/components/parameters/uploadType" },
  270. { $ref: "#/components/parameters/upload_protocol" },
  271. ],
  272. },
  273. "/v1/accounts:sendVerificationCode": {
  274. post: {
  275. description: "Sends a SMS verification code for phone number sign-in. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
  276. operationId: "identitytoolkit.accounts.sendVerificationCode",
  277. responses: {
  278. "200": {
  279. description: "Successful response",
  280. content: {
  281. "*/*": {
  282. schema: {
  283. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SendVerificationCodeResponse",
  284. },
  285. },
  286. },
  287. },
  288. },
  289. requestBody: {
  290. content: {
  291. "application/json": {
  292. schema: {
  293. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest",
  294. },
  295. },
  296. },
  297. },
  298. security: [
  299. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  300. { apiKeyQuery: [] },
  301. { apiKeyHeader: [] },
  302. ],
  303. tags: ["accounts"],
  304. },
  305. parameters: [
  306. { $ref: "#/components/parameters/access_token" },
  307. { $ref: "#/components/parameters/alt" },
  308. { $ref: "#/components/parameters/callback" },
  309. { $ref: "#/components/parameters/fields" },
  310. { $ref: "#/components/parameters/oauth_token" },
  311. { $ref: "#/components/parameters/prettyPrint" },
  312. { $ref: "#/components/parameters/quotaUser" },
  313. { $ref: "#/components/parameters/uploadType" },
  314. { $ref: "#/components/parameters/upload_protocol" },
  315. ],
  316. },
  317. "/v1/accounts:signInWithCustomToken": {
  318. post: {
  319. description: "Signs in or signs up a user by exchanging a custom Auth token. Upon a successful sign-in or sign-up, a new Identity Platform ID token and refresh token are issued for the user. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
  320. operationId: "identitytoolkit.accounts.signInWithCustomToken",
  321. responses: {
  322. "200": {
  323. description: "Successful response",
  324. content: {
  325. "*/*": {
  326. schema: {
  327. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithCustomTokenResponse",
  328. },
  329. },
  330. },
  331. },
  332. },
  333. requestBody: {
  334. content: {
  335. "application/json": {
  336. schema: {
  337. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithCustomTokenRequest",
  338. },
  339. },
  340. },
  341. },
  342. security: [
  343. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  344. { apiKeyQuery: [] },
  345. { apiKeyHeader: [] },
  346. ],
  347. tags: ["accounts"],
  348. },
  349. parameters: [
  350. { $ref: "#/components/parameters/access_token" },
  351. { $ref: "#/components/parameters/alt" },
  352. { $ref: "#/components/parameters/callback" },
  353. { $ref: "#/components/parameters/fields" },
  354. { $ref: "#/components/parameters/oauth_token" },
  355. { $ref: "#/components/parameters/prettyPrint" },
  356. { $ref: "#/components/parameters/quotaUser" },
  357. { $ref: "#/components/parameters/uploadType" },
  358. { $ref: "#/components/parameters/upload_protocol" },
  359. ],
  360. },
  361. "/v1/accounts:signInWithEmailLink": {
  362. post: {
  363. description: "Signs in or signs up a user with a out-of-band code from an email link. If a user does not exist with the given email address, a user record will be created. If the sign-in succeeds, an Identity Platform ID and refresh token are issued for the authenticated user. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
  364. operationId: "identitytoolkit.accounts.signInWithEmailLink",
  365. responses: {
  366. "200": {
  367. description: "Successful response",
  368. content: {
  369. "*/*": {
  370. schema: {
  371. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithEmailLinkResponse",
  372. },
  373. },
  374. },
  375. },
  376. },
  377. requestBody: {
  378. content: {
  379. "application/json": {
  380. schema: {
  381. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithEmailLinkRequest",
  382. },
  383. },
  384. },
  385. },
  386. security: [
  387. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  388. { apiKeyQuery: [] },
  389. { apiKeyHeader: [] },
  390. ],
  391. tags: ["accounts"],
  392. },
  393. parameters: [
  394. { $ref: "#/components/parameters/access_token" },
  395. { $ref: "#/components/parameters/alt" },
  396. { $ref: "#/components/parameters/callback" },
  397. { $ref: "#/components/parameters/fields" },
  398. { $ref: "#/components/parameters/oauth_token" },
  399. { $ref: "#/components/parameters/prettyPrint" },
  400. { $ref: "#/components/parameters/quotaUser" },
  401. { $ref: "#/components/parameters/uploadType" },
  402. { $ref: "#/components/parameters/upload_protocol" },
  403. ],
  404. },
  405. "/v1/accounts:signInWithGameCenter": {
  406. post: {
  407. description: "Signs in or signs up a user with iOS Game Center credentials. If the sign-in succeeds, a new Identity Platform ID token and refresh token are issued for the authenticated user. The bundle ID is required in the request header as `x-ios-bundle-identifier`. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
  408. operationId: "identitytoolkit.accounts.signInWithGameCenter",
  409. responses: {
  410. "200": {
  411. description: "Successful response",
  412. content: {
  413. "*/*": {
  414. schema: {
  415. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithGameCenterResponse",
  416. },
  417. },
  418. },
  419. },
  420. },
  421. requestBody: {
  422. content: {
  423. "application/json": {
  424. schema: {
  425. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithGameCenterRequest",
  426. },
  427. },
  428. },
  429. },
  430. security: [
  431. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  432. { apiKeyQuery: [] },
  433. { apiKeyHeader: [] },
  434. ],
  435. tags: ["accounts"],
  436. },
  437. parameters: [
  438. { $ref: "#/components/parameters/access_token" },
  439. { $ref: "#/components/parameters/alt" },
  440. { $ref: "#/components/parameters/callback" },
  441. { $ref: "#/components/parameters/fields" },
  442. { $ref: "#/components/parameters/oauth_token" },
  443. { $ref: "#/components/parameters/prettyPrint" },
  444. { $ref: "#/components/parameters/quotaUser" },
  445. { $ref: "#/components/parameters/uploadType" },
  446. { $ref: "#/components/parameters/upload_protocol" },
  447. ],
  448. },
  449. "/v1/accounts:signInWithIdp": {
  450. post: {
  451. description: 'Signs in or signs up a user using credentials from an Identity Provider (IdP). This is done by manually providing an IdP credential, or by providing the authorization response obtained via the authorization request from CreateAuthUri. If the sign-in succeeds, a new Identity Platform ID token and refresh token are issued for the authenticated user. A new Identity Platform user account will be created if the user has not previously signed in to the IdP with the same account. In addition, when the "One account per email address" setting is enabled, there should not be an existing Identity Platform user account with the same email address for a new user account to be created. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.',
  452. operationId: "identitytoolkit.accounts.signInWithIdp",
  453. responses: {
  454. "200": {
  455. description: "Successful response",
  456. content: {
  457. "*/*": {
  458. schema: {
  459. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithIdpResponse",
  460. },
  461. },
  462. },
  463. },
  464. },
  465. requestBody: {
  466. content: {
  467. "application/json": {
  468. schema: {
  469. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithIdpRequest",
  470. },
  471. },
  472. },
  473. },
  474. security: [
  475. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  476. { apiKeyQuery: [] },
  477. { apiKeyHeader: [] },
  478. ],
  479. tags: ["accounts"],
  480. },
  481. parameters: [
  482. { $ref: "#/components/parameters/access_token" },
  483. { $ref: "#/components/parameters/alt" },
  484. { $ref: "#/components/parameters/callback" },
  485. { $ref: "#/components/parameters/fields" },
  486. { $ref: "#/components/parameters/oauth_token" },
  487. { $ref: "#/components/parameters/prettyPrint" },
  488. { $ref: "#/components/parameters/quotaUser" },
  489. { $ref: "#/components/parameters/uploadType" },
  490. { $ref: "#/components/parameters/upload_protocol" },
  491. ],
  492. },
  493. "/v1/accounts:signInWithPassword": {
  494. post: {
  495. description: "Signs in a user with email and password. If the sign-in succeeds, a new Identity Platform ID token and refresh token are issued for the authenticated user. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
  496. operationId: "identitytoolkit.accounts.signInWithPassword",
  497. responses: {
  498. "200": {
  499. description: "Successful response",
  500. content: {
  501. "*/*": {
  502. schema: {
  503. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithPasswordResponse",
  504. },
  505. },
  506. },
  507. },
  508. },
  509. requestBody: {
  510. content: {
  511. "application/json": {
  512. schema: {
  513. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithPasswordRequest",
  514. },
  515. },
  516. },
  517. },
  518. security: [
  519. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  520. { apiKeyQuery: [] },
  521. { apiKeyHeader: [] },
  522. ],
  523. tags: ["accounts"],
  524. },
  525. parameters: [
  526. { $ref: "#/components/parameters/access_token" },
  527. { $ref: "#/components/parameters/alt" },
  528. { $ref: "#/components/parameters/callback" },
  529. { $ref: "#/components/parameters/fields" },
  530. { $ref: "#/components/parameters/oauth_token" },
  531. { $ref: "#/components/parameters/prettyPrint" },
  532. { $ref: "#/components/parameters/quotaUser" },
  533. { $ref: "#/components/parameters/uploadType" },
  534. { $ref: "#/components/parameters/upload_protocol" },
  535. ],
  536. },
  537. "/v1/accounts:signInWithPhoneNumber": {
  538. post: {
  539. description: "Completes a phone number authentication attempt. If a user already exists with the given phone number, an ID token is minted for that user. Otherwise, a new user is created and associated with the phone number. This method may also be used to link a phone number to an existing user. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
  540. operationId: "identitytoolkit.accounts.signInWithPhoneNumber",
  541. responses: {
  542. "200": {
  543. description: "Successful response",
  544. content: {
  545. "*/*": {
  546. schema: {
  547. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberResponse",
  548. },
  549. },
  550. },
  551. },
  552. },
  553. requestBody: {
  554. content: {
  555. "application/json": {
  556. schema: {
  557. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberRequest",
  558. },
  559. },
  560. },
  561. },
  562. security: [
  563. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  564. { apiKeyQuery: [] },
  565. { apiKeyHeader: [] },
  566. ],
  567. tags: ["accounts"],
  568. },
  569. parameters: [
  570. { $ref: "#/components/parameters/access_token" },
  571. { $ref: "#/components/parameters/alt" },
  572. { $ref: "#/components/parameters/callback" },
  573. { $ref: "#/components/parameters/fields" },
  574. { $ref: "#/components/parameters/oauth_token" },
  575. { $ref: "#/components/parameters/prettyPrint" },
  576. { $ref: "#/components/parameters/quotaUser" },
  577. { $ref: "#/components/parameters/uploadType" },
  578. { $ref: "#/components/parameters/upload_protocol" },
  579. ],
  580. },
  581. "/v1/accounts:signUp": {
  582. post: {
  583. description: "Signs up a new email and password user or anonymous user, or upgrades an anonymous user to email and password. For an admin request with a Google OAuth 2.0 credential with the proper [permissions](https://cloud.google.com/identity-platform/docs/access-control), creates a new anonymous, email and password, or phone number user. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
  584. operationId: "identitytoolkit.accounts.signUp",
  585. responses: {
  586. "200": {
  587. description: "Successful response",
  588. content: {
  589. "*/*": {
  590. schema: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignUpResponse" },
  591. },
  592. },
  593. },
  594. },
  595. requestBody: {
  596. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1SignUpRequest",
  597. },
  598. security: [
  599. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  600. { apiKeyQuery: [] },
  601. { apiKeyHeader: [] },
  602. ],
  603. tags: ["accounts"],
  604. },
  605. parameters: [
  606. { $ref: "#/components/parameters/access_token" },
  607. { $ref: "#/components/parameters/alt" },
  608. { $ref: "#/components/parameters/callback" },
  609. { $ref: "#/components/parameters/fields" },
  610. { $ref: "#/components/parameters/oauth_token" },
  611. { $ref: "#/components/parameters/prettyPrint" },
  612. { $ref: "#/components/parameters/quotaUser" },
  613. { $ref: "#/components/parameters/uploadType" },
  614. { $ref: "#/components/parameters/upload_protocol" },
  615. ],
  616. },
  617. "/v1/accounts:update": {
  618. post: {
  619. description: "Updates account-related information for the specified user by setting specific fields or applying action codes. Requests from administrators and end users are supported.",
  620. operationId: "identitytoolkit.accounts.update",
  621. responses: {
  622. "200": {
  623. description: "Successful response",
  624. content: {
  625. "*/*": {
  626. schema: {
  627. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SetAccountInfoResponse",
  628. },
  629. },
  630. },
  631. },
  632. },
  633. requestBody: {
  634. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1SetAccountInfoRequest",
  635. },
  636. security: [
  637. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  638. { apiKeyQuery: [] },
  639. { apiKeyHeader: [] },
  640. ],
  641. tags: ["accounts"],
  642. },
  643. parameters: [
  644. { $ref: "#/components/parameters/access_token" },
  645. { $ref: "#/components/parameters/alt" },
  646. { $ref: "#/components/parameters/callback" },
  647. { $ref: "#/components/parameters/fields" },
  648. { $ref: "#/components/parameters/oauth_token" },
  649. { $ref: "#/components/parameters/prettyPrint" },
  650. { $ref: "#/components/parameters/quotaUser" },
  651. { $ref: "#/components/parameters/uploadType" },
  652. { $ref: "#/components/parameters/upload_protocol" },
  653. ],
  654. },
  655. "/v1/accounts:verifyIosClient": {
  656. post: {
  657. description: "Verifies an iOS client is a real iOS device. If the request is valid, a receipt will be sent in the response and a secret will be sent via Apple Push Notification Service. The client should send both of them back to certain Identity Platform APIs in a later call (for example, /accounts:sendVerificationCode), in order to verify the client. The bundle ID is required in the request header as `x-ios-bundle-identifier`. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
  658. operationId: "identitytoolkit.accounts.verifyIosClient",
  659. responses: {
  660. "200": {
  661. description: "Successful response",
  662. content: {
  663. "*/*": {
  664. schema: {
  665. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1VerifyIosClientResponse",
  666. },
  667. },
  668. },
  669. },
  670. },
  671. requestBody: {
  672. content: {
  673. "application/json": {
  674. schema: {
  675. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1VerifyIosClientRequest",
  676. },
  677. },
  678. },
  679. },
  680. security: [
  681. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  682. { apiKeyQuery: [] },
  683. { apiKeyHeader: [] },
  684. ],
  685. tags: ["accounts"],
  686. },
  687. parameters: [
  688. { $ref: "#/components/parameters/access_token" },
  689. { $ref: "#/components/parameters/alt" },
  690. { $ref: "#/components/parameters/callback" },
  691. { $ref: "#/components/parameters/fields" },
  692. { $ref: "#/components/parameters/oauth_token" },
  693. { $ref: "#/components/parameters/prettyPrint" },
  694. { $ref: "#/components/parameters/quotaUser" },
  695. { $ref: "#/components/parameters/uploadType" },
  696. { $ref: "#/components/parameters/upload_protocol" },
  697. ],
  698. },
  699. "/v1/projects/{targetProjectId}/accounts": {
  700. post: {
  701. description: "Signs up a new email and password user or anonymous user, or upgrades an anonymous user to email and password. For an admin request with a Google OAuth 2.0 credential with the proper [permissions](https://cloud.google.com/identity-platform/docs/access-control), creates a new anonymous, email and password, or phone number user. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
  702. operationId: "identitytoolkit.projects.accounts",
  703. responses: {
  704. "200": {
  705. description: "Successful response",
  706. content: {
  707. "*/*": {
  708. schema: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignUpResponse" },
  709. },
  710. },
  711. },
  712. },
  713. parameters: [
  714. {
  715. name: "targetProjectId",
  716. in: "path",
  717. description: "The project ID of the project which the user should belong to. Specifying this field requires a Google OAuth 2.0 credential with the proper [permissions](https://cloud.google.com/identity-platform/docs/access-control). If this is not set, the target project is inferred from the scope associated to the Bearer access token.",
  718. required: true,
  719. schema: { type: "string" },
  720. },
  721. ],
  722. requestBody: {
  723. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1SignUpRequest",
  724. },
  725. security: [
  726. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  727. { apiKeyQuery: [] },
  728. { apiKeyHeader: [] },
  729. ],
  730. tags: ["projects"],
  731. },
  732. parameters: [
  733. { $ref: "#/components/parameters/access_token" },
  734. { $ref: "#/components/parameters/alt" },
  735. { $ref: "#/components/parameters/callback" },
  736. { $ref: "#/components/parameters/fields" },
  737. { $ref: "#/components/parameters/oauth_token" },
  738. { $ref: "#/components/parameters/prettyPrint" },
  739. { $ref: "#/components/parameters/quotaUser" },
  740. { $ref: "#/components/parameters/uploadType" },
  741. { $ref: "#/components/parameters/upload_protocol" },
  742. ],
  743. },
  744. "/v1/projects/{targetProjectId}:createSessionCookie": {
  745. post: {
  746. description: "Creates a session cookie for the given Identity Platform ID token. The session cookie is used by the client to preserve the user's login state.",
  747. operationId: "identitytoolkit.projects.createSessionCookie",
  748. responses: {
  749. "200": {
  750. description: "Successful response",
  751. content: {
  752. "*/*": {
  753. schema: {
  754. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1CreateSessionCookieResponse",
  755. },
  756. },
  757. },
  758. },
  759. },
  760. parameters: [
  761. {
  762. name: "targetProjectId",
  763. in: "path",
  764. description: "The ID of the project that the account belongs to.",
  765. required: true,
  766. schema: { type: "string" },
  767. },
  768. ],
  769. requestBody: {
  770. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1CreateSessionCookieRequest",
  771. },
  772. security: [
  773. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  774. { apiKeyQuery: [] },
  775. { apiKeyHeader: [] },
  776. ],
  777. tags: ["projects"],
  778. },
  779. parameters: [
  780. { $ref: "#/components/parameters/access_token" },
  781. { $ref: "#/components/parameters/alt" },
  782. { $ref: "#/components/parameters/callback" },
  783. { $ref: "#/components/parameters/fields" },
  784. { $ref: "#/components/parameters/oauth_token" },
  785. { $ref: "#/components/parameters/prettyPrint" },
  786. { $ref: "#/components/parameters/quotaUser" },
  787. { $ref: "#/components/parameters/uploadType" },
  788. { $ref: "#/components/parameters/upload_protocol" },
  789. ],
  790. },
  791. "/v1/projects/{targetProjectId}:queryAccounts": {
  792. post: {
  793. description: "Looks up user accounts within a project or a tenant based on conditions in the request.",
  794. operationId: "identitytoolkit.projects.queryAccounts",
  795. responses: {
  796. "200": {
  797. description: "Successful response",
  798. content: {
  799. "*/*": {
  800. schema: {
  801. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1QueryUserInfoResponse",
  802. },
  803. },
  804. },
  805. },
  806. },
  807. parameters: [
  808. {
  809. name: "targetProjectId",
  810. in: "path",
  811. description: "The ID of the project to which the result is scoped.",
  812. required: true,
  813. schema: { type: "string" },
  814. },
  815. ],
  816. requestBody: {
  817. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1QueryUserInfoRequest",
  818. },
  819. security: [
  820. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  821. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  822. { apiKeyQuery: [] },
  823. { apiKeyHeader: [] },
  824. ],
  825. tags: ["projects"],
  826. },
  827. parameters: [
  828. { $ref: "#/components/parameters/access_token" },
  829. { $ref: "#/components/parameters/alt" },
  830. { $ref: "#/components/parameters/callback" },
  831. { $ref: "#/components/parameters/fields" },
  832. { $ref: "#/components/parameters/oauth_token" },
  833. { $ref: "#/components/parameters/prettyPrint" },
  834. { $ref: "#/components/parameters/quotaUser" },
  835. { $ref: "#/components/parameters/uploadType" },
  836. { $ref: "#/components/parameters/upload_protocol" },
  837. ],
  838. },
  839. "/v1/projects/{targetProjectId}/accounts:batchCreate": {
  840. post: {
  841. description: "Uploads multiple accounts into the Google Cloud project. If there is a problem uploading one or more of the accounts, the rest will be uploaded, and a list of the errors will be returned. To use this method requires a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).",
  842. operationId: "identitytoolkit.projects.accounts.batchCreate",
  843. responses: {
  844. "200": {
  845. description: "Successful response",
  846. content: {
  847. "*/*": {
  848. schema: {
  849. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1UploadAccountResponse",
  850. },
  851. },
  852. },
  853. },
  854. },
  855. parameters: [
  856. {
  857. name: "targetProjectId",
  858. in: "path",
  859. description: "The Project ID of the Identity Platform project which the account belongs to.",
  860. required: true,
  861. schema: { type: "string" },
  862. },
  863. ],
  864. requestBody: {
  865. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1UploadAccountRequest",
  866. },
  867. security: [
  868. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  869. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  870. { apiKeyQuery: [] },
  871. { apiKeyHeader: [] },
  872. ],
  873. tags: ["projects"],
  874. },
  875. parameters: [
  876. { $ref: "#/components/parameters/access_token" },
  877. { $ref: "#/components/parameters/alt" },
  878. { $ref: "#/components/parameters/callback" },
  879. { $ref: "#/components/parameters/fields" },
  880. { $ref: "#/components/parameters/oauth_token" },
  881. { $ref: "#/components/parameters/prettyPrint" },
  882. { $ref: "#/components/parameters/quotaUser" },
  883. { $ref: "#/components/parameters/uploadType" },
  884. { $ref: "#/components/parameters/upload_protocol" },
  885. ],
  886. },
  887. "/v1/projects/{targetProjectId}/accounts:batchDelete": {
  888. post: {
  889. description: "Batch deletes multiple accounts. For accounts that fail to be deleted, error info is contained in the response. The method ignores accounts that do not exist or are duplicated in the request. This method requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control).",
  890. operationId: "identitytoolkit.projects.accounts.batchDelete",
  891. responses: {
  892. "200": {
  893. description: "Successful response",
  894. content: {
  895. "*/*": {
  896. schema: {
  897. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1BatchDeleteAccountsResponse",
  898. },
  899. },
  900. },
  901. },
  902. },
  903. parameters: [
  904. {
  905. name: "targetProjectId",
  906. in: "path",
  907. description: "If `tenant_id` is specified, the ID of the Google Cloud project that the Identity Platform tenant belongs to. Otherwise, the ID of the Google Cloud project that accounts belong to.",
  908. required: true,
  909. schema: { type: "string" },
  910. },
  911. ],
  912. requestBody: {
  913. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1BatchDeleteAccountsRequest",
  914. },
  915. security: [
  916. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  917. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  918. { apiKeyQuery: [] },
  919. { apiKeyHeader: [] },
  920. ],
  921. tags: ["projects"],
  922. },
  923. parameters: [
  924. { $ref: "#/components/parameters/access_token" },
  925. { $ref: "#/components/parameters/alt" },
  926. { $ref: "#/components/parameters/callback" },
  927. { $ref: "#/components/parameters/fields" },
  928. { $ref: "#/components/parameters/oauth_token" },
  929. { $ref: "#/components/parameters/prettyPrint" },
  930. { $ref: "#/components/parameters/quotaUser" },
  931. { $ref: "#/components/parameters/uploadType" },
  932. { $ref: "#/components/parameters/upload_protocol" },
  933. ],
  934. },
  935. "/v1/projects/{targetProjectId}/accounts:batchGet": {
  936. get: {
  937. description: "Download account information for all accounts on the project in a paginated manner. To use this method requires a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).. Furthermore, additional permissions are needed to get password hash, password salt, and password version from accounts; otherwise these fields are redacted.",
  938. operationId: "identitytoolkit.projects.accounts.batchGet",
  939. responses: {
  940. "200": {
  941. description: "Successful response",
  942. content: {
  943. "*/*": {
  944. schema: {
  945. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1DownloadAccountResponse",
  946. },
  947. },
  948. },
  949. },
  950. },
  951. parameters: [
  952. {
  953. name: "targetProjectId",
  954. in: "path",
  955. description: "If `tenant_id` is specified, the ID of the Google Cloud project that the Identity Platform tenant belongs to. Otherwise, the ID of the Google Cloud project that the accounts belong to.",
  956. required: true,
  957. schema: { type: "string" },
  958. },
  959. { name: "delegatedProjectNumber", in: "query", schema: { type: "string" } },
  960. {
  961. name: "maxResults",
  962. in: "query",
  963. description: "The maximum number of results to return. Must be at least 1 and no greater than 1000. By default, it is 20.",
  964. schema: { type: "integer" },
  965. },
  966. {
  967. name: "nextPageToken",
  968. in: "query",
  969. description: "The pagination token from the response of a previous request.",
  970. schema: { type: "string" },
  971. },
  972. {
  973. name: "tenantId",
  974. in: "query",
  975. description: "The ID of the Identity Platform tenant the accounts belongs to. If not specified, accounts on the Identity Platform project are returned.",
  976. schema: { type: "string" },
  977. },
  978. ],
  979. security: [
  980. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  981. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  982. { apiKeyQuery: [] },
  983. { apiKeyHeader: [] },
  984. ],
  985. tags: ["projects"],
  986. },
  987. parameters: [
  988. { $ref: "#/components/parameters/access_token" },
  989. { $ref: "#/components/parameters/alt" },
  990. { $ref: "#/components/parameters/callback" },
  991. { $ref: "#/components/parameters/fields" },
  992. { $ref: "#/components/parameters/oauth_token" },
  993. { $ref: "#/components/parameters/prettyPrint" },
  994. { $ref: "#/components/parameters/quotaUser" },
  995. { $ref: "#/components/parameters/uploadType" },
  996. { $ref: "#/components/parameters/upload_protocol" },
  997. ],
  998. },
  999. "/v1/projects/{targetProjectId}/accounts:delete": {
  1000. post: {
  1001. description: "Deletes a user's account.",
  1002. operationId: "identitytoolkit.projects.accounts.delete",
  1003. responses: {
  1004. "200": {
  1005. description: "Successful response",
  1006. content: {
  1007. "*/*": {
  1008. schema: {
  1009. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1DeleteAccountResponse",
  1010. },
  1011. },
  1012. },
  1013. },
  1014. },
  1015. parameters: [
  1016. {
  1017. name: "targetProjectId",
  1018. in: "path",
  1019. description: "The ID of the project which the account belongs to. Should only be specified in authenticated requests that specify local_id of an account.",
  1020. required: true,
  1021. schema: { type: "string" },
  1022. },
  1023. ],
  1024. requestBody: {
  1025. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1DeleteAccountRequest",
  1026. },
  1027. security: [
  1028. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  1029. { apiKeyQuery: [] },
  1030. { apiKeyHeader: [] },
  1031. ],
  1032. tags: ["projects"],
  1033. },
  1034. parameters: [
  1035. { $ref: "#/components/parameters/access_token" },
  1036. { $ref: "#/components/parameters/alt" },
  1037. { $ref: "#/components/parameters/callback" },
  1038. { $ref: "#/components/parameters/fields" },
  1039. { $ref: "#/components/parameters/oauth_token" },
  1040. { $ref: "#/components/parameters/prettyPrint" },
  1041. { $ref: "#/components/parameters/quotaUser" },
  1042. { $ref: "#/components/parameters/uploadType" },
  1043. { $ref: "#/components/parameters/upload_protocol" },
  1044. ],
  1045. },
  1046. "/v1/projects/{targetProjectId}/accounts:lookup": {
  1047. post: {
  1048. description: "Gets account information for all matched accounts. For an end user request, retrieves the account of the end user. For an admin request with Google OAuth 2.0 credential, retrieves one or multiple account(s) with matching criteria.",
  1049. operationId: "identitytoolkit.projects.accounts.lookup",
  1050. responses: {
  1051. "200": {
  1052. description: "Successful response",
  1053. content: {
  1054. "*/*": {
  1055. schema: {
  1056. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1GetAccountInfoResponse",
  1057. },
  1058. },
  1059. },
  1060. },
  1061. },
  1062. parameters: [
  1063. {
  1064. name: "targetProjectId",
  1065. in: "path",
  1066. description: "The ID of the Google Cloud project that the account or the Identity Platform tenant specified by `tenant_id` belongs to. Should only be specified by authenticated requests bearing a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).",
  1067. required: true,
  1068. schema: { type: "string" },
  1069. },
  1070. ],
  1071. requestBody: {
  1072. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1GetAccountInfoRequest",
  1073. },
  1074. security: [
  1075. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  1076. { apiKeyQuery: [] },
  1077. { apiKeyHeader: [] },
  1078. ],
  1079. tags: ["projects"],
  1080. },
  1081. parameters: [
  1082. { $ref: "#/components/parameters/access_token" },
  1083. { $ref: "#/components/parameters/alt" },
  1084. { $ref: "#/components/parameters/callback" },
  1085. { $ref: "#/components/parameters/fields" },
  1086. { $ref: "#/components/parameters/oauth_token" },
  1087. { $ref: "#/components/parameters/prettyPrint" },
  1088. { $ref: "#/components/parameters/quotaUser" },
  1089. { $ref: "#/components/parameters/uploadType" },
  1090. { $ref: "#/components/parameters/upload_protocol" },
  1091. ],
  1092. },
  1093. "/v1/projects/{targetProjectId}/accounts:query": {
  1094. post: {
  1095. description: "Looks up user accounts within a project or a tenant based on conditions in the request.",
  1096. operationId: "identitytoolkit.projects.accounts.query",
  1097. responses: {
  1098. "200": {
  1099. description: "Successful response",
  1100. content: {
  1101. "*/*": {
  1102. schema: {
  1103. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1QueryUserInfoResponse",
  1104. },
  1105. },
  1106. },
  1107. },
  1108. },
  1109. parameters: [
  1110. {
  1111. name: "targetProjectId",
  1112. in: "path",
  1113. description: "The ID of the project to which the result is scoped.",
  1114. required: true,
  1115. schema: { type: "string" },
  1116. },
  1117. ],
  1118. requestBody: {
  1119. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1QueryUserInfoRequest",
  1120. },
  1121. security: [
  1122. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  1123. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  1124. { apiKeyQuery: [] },
  1125. { apiKeyHeader: [] },
  1126. ],
  1127. tags: ["projects"],
  1128. },
  1129. parameters: [
  1130. { $ref: "#/components/parameters/access_token" },
  1131. { $ref: "#/components/parameters/alt" },
  1132. { $ref: "#/components/parameters/callback" },
  1133. { $ref: "#/components/parameters/fields" },
  1134. { $ref: "#/components/parameters/oauth_token" },
  1135. { $ref: "#/components/parameters/prettyPrint" },
  1136. { $ref: "#/components/parameters/quotaUser" },
  1137. { $ref: "#/components/parameters/uploadType" },
  1138. { $ref: "#/components/parameters/upload_protocol" },
  1139. ],
  1140. },
  1141. "/v1/projects/{targetProjectId}/accounts:sendOobCode": {
  1142. post: {
  1143. description: "Sends an out-of-band confirmation code for an account. Requests from a authenticated request can optionally return a link including the OOB code instead of sending it.",
  1144. operationId: "identitytoolkit.projects.accounts.sendOobCode",
  1145. responses: {
  1146. "200": {
  1147. description: "Successful response",
  1148. content: {
  1149. "*/*": {
  1150. schema: {
  1151. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1GetOobCodeResponse",
  1152. },
  1153. },
  1154. },
  1155. },
  1156. },
  1157. parameters: [
  1158. {
  1159. name: "targetProjectId",
  1160. in: "path",
  1161. description: "The Project ID of the Identity Platform project which the account belongs to. To specify this field, it requires a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).",
  1162. required: true,
  1163. schema: { type: "string" },
  1164. },
  1165. ],
  1166. requestBody: {
  1167. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1GetOobCodeRequest",
  1168. },
  1169. security: [
  1170. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  1171. { apiKeyQuery: [] },
  1172. { apiKeyHeader: [] },
  1173. ],
  1174. tags: ["projects"],
  1175. },
  1176. parameters: [
  1177. { $ref: "#/components/parameters/access_token" },
  1178. { $ref: "#/components/parameters/alt" },
  1179. { $ref: "#/components/parameters/callback" },
  1180. { $ref: "#/components/parameters/fields" },
  1181. { $ref: "#/components/parameters/oauth_token" },
  1182. { $ref: "#/components/parameters/prettyPrint" },
  1183. { $ref: "#/components/parameters/quotaUser" },
  1184. { $ref: "#/components/parameters/uploadType" },
  1185. { $ref: "#/components/parameters/upload_protocol" },
  1186. ],
  1187. },
  1188. "/v1/projects/{targetProjectId}/accounts:update": {
  1189. post: {
  1190. description: "Updates account-related information for the specified user by setting specific fields or applying action codes. Requests from administrators and end users are supported.",
  1191. operationId: "identitytoolkit.projects.accounts.update",
  1192. responses: {
  1193. "200": {
  1194. description: "Successful response",
  1195. content: {
  1196. "*/*": {
  1197. schema: {
  1198. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SetAccountInfoResponse",
  1199. },
  1200. },
  1201. },
  1202. },
  1203. },
  1204. parameters: [
  1205. {
  1206. name: "targetProjectId",
  1207. in: "path",
  1208. description: "The project ID for the project that the account belongs to. Specifying this field requires Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control). Requests from end users should pass an Identity Platform ID token instead.",
  1209. required: true,
  1210. schema: { type: "string" },
  1211. },
  1212. ],
  1213. requestBody: {
  1214. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1SetAccountInfoRequest",
  1215. },
  1216. security: [
  1217. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  1218. { apiKeyQuery: [] },
  1219. { apiKeyHeader: [] },
  1220. ],
  1221. tags: ["projects"],
  1222. },
  1223. parameters: [
  1224. { $ref: "#/components/parameters/access_token" },
  1225. { $ref: "#/components/parameters/alt" },
  1226. { $ref: "#/components/parameters/callback" },
  1227. { $ref: "#/components/parameters/fields" },
  1228. { $ref: "#/components/parameters/oauth_token" },
  1229. { $ref: "#/components/parameters/prettyPrint" },
  1230. { $ref: "#/components/parameters/quotaUser" },
  1231. { $ref: "#/components/parameters/uploadType" },
  1232. { $ref: "#/components/parameters/upload_protocol" },
  1233. ],
  1234. },
  1235. "/v1/projects/{targetProjectId}/tenants/{tenantId}/accounts": {
  1236. post: {
  1237. description: "Signs up a new email and password user or anonymous user, or upgrades an anonymous user to email and password. For an admin request with a Google OAuth 2.0 credential with the proper [permissions](https://cloud.google.com/identity-platform/docs/access-control), creates a new anonymous, email and password, or phone number user. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
  1238. operationId: "identitytoolkit.projects.tenants.accounts",
  1239. responses: {
  1240. "200": {
  1241. description: "Successful response",
  1242. content: {
  1243. "*/*": {
  1244. schema: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignUpResponse" },
  1245. },
  1246. },
  1247. },
  1248. },
  1249. parameters: [
  1250. {
  1251. name: "targetProjectId",
  1252. in: "path",
  1253. description: "The project ID of the project which the user should belong to. Specifying this field requires a Google OAuth 2.0 credential with the proper [permissions](https://cloud.google.com/identity-platform/docs/access-control). If this is not set, the target project is inferred from the scope associated to the Bearer access token.",
  1254. required: true,
  1255. schema: { type: "string" },
  1256. },
  1257. {
  1258. name: "tenantId",
  1259. in: "path",
  1260. description: "The ID of the Identity Platform tenant to create a user under. If not set, the user will be created under the default Identity Platform project.",
  1261. required: true,
  1262. schema: { type: "string" },
  1263. },
  1264. ],
  1265. requestBody: {
  1266. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1SignUpRequest",
  1267. },
  1268. security: [
  1269. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  1270. { apiKeyQuery: [] },
  1271. { apiKeyHeader: [] },
  1272. ],
  1273. tags: ["projects"],
  1274. },
  1275. parameters: [
  1276. { $ref: "#/components/parameters/access_token" },
  1277. { $ref: "#/components/parameters/alt" },
  1278. { $ref: "#/components/parameters/callback" },
  1279. { $ref: "#/components/parameters/fields" },
  1280. { $ref: "#/components/parameters/oauth_token" },
  1281. { $ref: "#/components/parameters/prettyPrint" },
  1282. { $ref: "#/components/parameters/quotaUser" },
  1283. { $ref: "#/components/parameters/uploadType" },
  1284. { $ref: "#/components/parameters/upload_protocol" },
  1285. ],
  1286. },
  1287. "/v1/projects/{targetProjectId}/tenants/{tenantId}:createSessionCookie": {
  1288. post: {
  1289. description: "Creates a session cookie for the given Identity Platform ID token. The session cookie is used by the client to preserve the user's login state.",
  1290. operationId: "identitytoolkit.projects.tenants.createSessionCookie",
  1291. responses: {
  1292. "200": {
  1293. description: "Successful response",
  1294. content: {
  1295. "*/*": {
  1296. schema: {
  1297. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1CreateSessionCookieResponse",
  1298. },
  1299. },
  1300. },
  1301. },
  1302. },
  1303. parameters: [
  1304. {
  1305. name: "targetProjectId",
  1306. in: "path",
  1307. description: "The ID of the project that the account belongs to.",
  1308. required: true,
  1309. schema: { type: "string" },
  1310. },
  1311. {
  1312. name: "tenantId",
  1313. in: "path",
  1314. description: "The tenant ID of the Identity Platform tenant the account belongs to.",
  1315. required: true,
  1316. schema: { type: "string" },
  1317. },
  1318. ],
  1319. requestBody: {
  1320. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1CreateSessionCookieRequest",
  1321. },
  1322. security: [
  1323. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  1324. { apiKeyQuery: [] },
  1325. { apiKeyHeader: [] },
  1326. ],
  1327. tags: ["projects"],
  1328. },
  1329. parameters: [
  1330. { $ref: "#/components/parameters/access_token" },
  1331. { $ref: "#/components/parameters/alt" },
  1332. { $ref: "#/components/parameters/callback" },
  1333. { $ref: "#/components/parameters/fields" },
  1334. { $ref: "#/components/parameters/oauth_token" },
  1335. { $ref: "#/components/parameters/prettyPrint" },
  1336. { $ref: "#/components/parameters/quotaUser" },
  1337. { $ref: "#/components/parameters/uploadType" },
  1338. { $ref: "#/components/parameters/upload_protocol" },
  1339. ],
  1340. },
  1341. "/v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchCreate": {
  1342. post: {
  1343. description: "Uploads multiple accounts into the Google Cloud project. If there is a problem uploading one or more of the accounts, the rest will be uploaded, and a list of the errors will be returned. To use this method requires a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).",
  1344. operationId: "identitytoolkit.projects.tenants.accounts.batchCreate",
  1345. responses: {
  1346. "200": {
  1347. description: "Successful response",
  1348. content: {
  1349. "*/*": {
  1350. schema: {
  1351. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1UploadAccountResponse",
  1352. },
  1353. },
  1354. },
  1355. },
  1356. },
  1357. parameters: [
  1358. {
  1359. name: "targetProjectId",
  1360. in: "path",
  1361. description: "The Project ID of the Identity Platform project which the account belongs to.",
  1362. required: true,
  1363. schema: { type: "string" },
  1364. },
  1365. {
  1366. name: "tenantId",
  1367. in: "path",
  1368. description: "The ID of the Identity Platform tenant the account belongs to.",
  1369. required: true,
  1370. schema: { type: "string" },
  1371. },
  1372. ],
  1373. requestBody: {
  1374. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1UploadAccountRequest",
  1375. },
  1376. security: [
  1377. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  1378. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  1379. { apiKeyQuery: [] },
  1380. { apiKeyHeader: [] },
  1381. ],
  1382. tags: ["projects"],
  1383. },
  1384. parameters: [
  1385. { $ref: "#/components/parameters/access_token" },
  1386. { $ref: "#/components/parameters/alt" },
  1387. { $ref: "#/components/parameters/callback" },
  1388. { $ref: "#/components/parameters/fields" },
  1389. { $ref: "#/components/parameters/oauth_token" },
  1390. { $ref: "#/components/parameters/prettyPrint" },
  1391. { $ref: "#/components/parameters/quotaUser" },
  1392. { $ref: "#/components/parameters/uploadType" },
  1393. { $ref: "#/components/parameters/upload_protocol" },
  1394. ],
  1395. },
  1396. "/v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchDelete": {
  1397. post: {
  1398. description: "Batch deletes multiple accounts. For accounts that fail to be deleted, error info is contained in the response. The method ignores accounts that do not exist or are duplicated in the request. This method requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control).",
  1399. operationId: "identitytoolkit.projects.tenants.accounts.batchDelete",
  1400. responses: {
  1401. "200": {
  1402. description: "Successful response",
  1403. content: {
  1404. "*/*": {
  1405. schema: {
  1406. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1BatchDeleteAccountsResponse",
  1407. },
  1408. },
  1409. },
  1410. },
  1411. },
  1412. parameters: [
  1413. {
  1414. name: "targetProjectId",
  1415. in: "path",
  1416. description: "If `tenant_id` is specified, the ID of the Google Cloud project that the Identity Platform tenant belongs to. Otherwise, the ID of the Google Cloud project that accounts belong to.",
  1417. required: true,
  1418. schema: { type: "string" },
  1419. },
  1420. {
  1421. name: "tenantId",
  1422. in: "path",
  1423. description: "If the accounts belong to an Identity Platform tenant, the ID of the tenant. If the accounts belong to an default Identity Platform project, the field is not needed.",
  1424. required: true,
  1425. schema: { type: "string" },
  1426. },
  1427. ],
  1428. requestBody: {
  1429. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1BatchDeleteAccountsRequest",
  1430. },
  1431. security: [
  1432. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  1433. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  1434. { apiKeyQuery: [] },
  1435. { apiKeyHeader: [] },
  1436. ],
  1437. tags: ["projects"],
  1438. },
  1439. parameters: [
  1440. { $ref: "#/components/parameters/access_token" },
  1441. { $ref: "#/components/parameters/alt" },
  1442. { $ref: "#/components/parameters/callback" },
  1443. { $ref: "#/components/parameters/fields" },
  1444. { $ref: "#/components/parameters/oauth_token" },
  1445. { $ref: "#/components/parameters/prettyPrint" },
  1446. { $ref: "#/components/parameters/quotaUser" },
  1447. { $ref: "#/components/parameters/uploadType" },
  1448. { $ref: "#/components/parameters/upload_protocol" },
  1449. ],
  1450. },
  1451. "/v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchGet": {
  1452. get: {
  1453. description: "Download account information for all accounts on the project in a paginated manner. To use this method requires a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).. Furthermore, additional permissions are needed to get password hash, password salt, and password version from accounts; otherwise these fields are redacted.",
  1454. operationId: "identitytoolkit.projects.tenants.accounts.batchGet",
  1455. responses: {
  1456. "200": {
  1457. description: "Successful response",
  1458. content: {
  1459. "*/*": {
  1460. schema: {
  1461. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1DownloadAccountResponse",
  1462. },
  1463. },
  1464. },
  1465. },
  1466. },
  1467. parameters: [
  1468. {
  1469. name: "targetProjectId",
  1470. in: "path",
  1471. description: "If `tenant_id` is specified, the ID of the Google Cloud project that the Identity Platform tenant belongs to. Otherwise, the ID of the Google Cloud project that the accounts belong to.",
  1472. required: true,
  1473. schema: { type: "string" },
  1474. },
  1475. {
  1476. name: "tenantId",
  1477. in: "path",
  1478. description: "The ID of the Identity Platform tenant the accounts belongs to. If not specified, accounts on the Identity Platform project are returned.",
  1479. required: true,
  1480. schema: { type: "string" },
  1481. },
  1482. { name: "delegatedProjectNumber", in: "query", schema: { type: "string" } },
  1483. {
  1484. name: "maxResults",
  1485. in: "query",
  1486. description: "The maximum number of results to return. Must be at least 1 and no greater than 1000. By default, it is 20.",
  1487. schema: { type: "integer" },
  1488. },
  1489. {
  1490. name: "nextPageToken",
  1491. in: "query",
  1492. description: "The pagination token from the response of a previous request.",
  1493. schema: { type: "string" },
  1494. },
  1495. ],
  1496. security: [
  1497. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  1498. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  1499. { apiKeyQuery: [] },
  1500. { apiKeyHeader: [] },
  1501. ],
  1502. tags: ["projects"],
  1503. },
  1504. parameters: [
  1505. { $ref: "#/components/parameters/access_token" },
  1506. { $ref: "#/components/parameters/alt" },
  1507. { $ref: "#/components/parameters/callback" },
  1508. { $ref: "#/components/parameters/fields" },
  1509. { $ref: "#/components/parameters/oauth_token" },
  1510. { $ref: "#/components/parameters/prettyPrint" },
  1511. { $ref: "#/components/parameters/quotaUser" },
  1512. { $ref: "#/components/parameters/uploadType" },
  1513. { $ref: "#/components/parameters/upload_protocol" },
  1514. ],
  1515. },
  1516. "/v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:delete": {
  1517. post: {
  1518. description: "Deletes a user's account.",
  1519. operationId: "identitytoolkit.projects.tenants.accounts.delete",
  1520. responses: {
  1521. "200": {
  1522. description: "Successful response",
  1523. content: {
  1524. "*/*": {
  1525. schema: {
  1526. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1DeleteAccountResponse",
  1527. },
  1528. },
  1529. },
  1530. },
  1531. },
  1532. parameters: [
  1533. {
  1534. name: "targetProjectId",
  1535. in: "path",
  1536. description: "The ID of the project which the account belongs to. Should only be specified in authenticated requests that specify local_id of an account.",
  1537. required: true,
  1538. schema: { type: "string" },
  1539. },
  1540. {
  1541. name: "tenantId",
  1542. in: "path",
  1543. description: "The ID of the tenant that the account belongs to, if applicable. Only require to be specified for authenticated requests bearing a Google OAuth 2.0 credential that specify local_id of an account that belongs to an Identity Platform tenant.",
  1544. required: true,
  1545. schema: { type: "string" },
  1546. },
  1547. ],
  1548. requestBody: {
  1549. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1DeleteAccountRequest",
  1550. },
  1551. security: [
  1552. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  1553. { apiKeyQuery: [] },
  1554. { apiKeyHeader: [] },
  1555. ],
  1556. tags: ["projects"],
  1557. },
  1558. parameters: [
  1559. { $ref: "#/components/parameters/access_token" },
  1560. { $ref: "#/components/parameters/alt" },
  1561. { $ref: "#/components/parameters/callback" },
  1562. { $ref: "#/components/parameters/fields" },
  1563. { $ref: "#/components/parameters/oauth_token" },
  1564. { $ref: "#/components/parameters/prettyPrint" },
  1565. { $ref: "#/components/parameters/quotaUser" },
  1566. { $ref: "#/components/parameters/uploadType" },
  1567. { $ref: "#/components/parameters/upload_protocol" },
  1568. ],
  1569. },
  1570. "/v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:lookup": {
  1571. post: {
  1572. description: "Gets account information for all matched accounts. For an end user request, retrieves the account of the end user. For an admin request with Google OAuth 2.0 credential, retrieves one or multiple account(s) with matching criteria.",
  1573. operationId: "identitytoolkit.projects.tenants.accounts.lookup",
  1574. responses: {
  1575. "200": {
  1576. description: "Successful response",
  1577. content: {
  1578. "*/*": {
  1579. schema: {
  1580. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1GetAccountInfoResponse",
  1581. },
  1582. },
  1583. },
  1584. },
  1585. },
  1586. parameters: [
  1587. {
  1588. name: "targetProjectId",
  1589. in: "path",
  1590. description: "The ID of the Google Cloud project that the account or the Identity Platform tenant specified by `tenant_id` belongs to. Should only be specified by authenticated requests bearing a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).",
  1591. required: true,
  1592. schema: { type: "string" },
  1593. },
  1594. {
  1595. name: "tenantId",
  1596. in: "path",
  1597. description: "The ID of the tenant that the account belongs to. Should only be specified by authenticated requests from a developer.",
  1598. required: true,
  1599. schema: { type: "string" },
  1600. },
  1601. ],
  1602. requestBody: {
  1603. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1GetAccountInfoRequest",
  1604. },
  1605. security: [
  1606. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  1607. { apiKeyQuery: [] },
  1608. { apiKeyHeader: [] },
  1609. ],
  1610. tags: ["projects"],
  1611. },
  1612. parameters: [
  1613. { $ref: "#/components/parameters/access_token" },
  1614. { $ref: "#/components/parameters/alt" },
  1615. { $ref: "#/components/parameters/callback" },
  1616. { $ref: "#/components/parameters/fields" },
  1617. { $ref: "#/components/parameters/oauth_token" },
  1618. { $ref: "#/components/parameters/prettyPrint" },
  1619. { $ref: "#/components/parameters/quotaUser" },
  1620. { $ref: "#/components/parameters/uploadType" },
  1621. { $ref: "#/components/parameters/upload_protocol" },
  1622. ],
  1623. },
  1624. "/v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:query": {
  1625. post: {
  1626. description: "Looks up user accounts within a project or a tenant based on conditions in the request.",
  1627. operationId: "identitytoolkit.projects.tenants.accounts.query",
  1628. responses: {
  1629. "200": {
  1630. description: "Successful response",
  1631. content: {
  1632. "*/*": {
  1633. schema: {
  1634. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1QueryUserInfoResponse",
  1635. },
  1636. },
  1637. },
  1638. },
  1639. },
  1640. parameters: [
  1641. {
  1642. name: "targetProjectId",
  1643. in: "path",
  1644. description: "The ID of the project to which the result is scoped.",
  1645. required: true,
  1646. schema: { type: "string" },
  1647. },
  1648. {
  1649. name: "tenantId",
  1650. in: "path",
  1651. description: "The ID of the tenant to which the result is scoped.",
  1652. required: true,
  1653. schema: { type: "string" },
  1654. },
  1655. ],
  1656. requestBody: {
  1657. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1QueryUserInfoRequest",
  1658. },
  1659. security: [
  1660. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  1661. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  1662. { apiKeyQuery: [] },
  1663. { apiKeyHeader: [] },
  1664. ],
  1665. tags: ["projects"],
  1666. },
  1667. parameters: [
  1668. { $ref: "#/components/parameters/access_token" },
  1669. { $ref: "#/components/parameters/alt" },
  1670. { $ref: "#/components/parameters/callback" },
  1671. { $ref: "#/components/parameters/fields" },
  1672. { $ref: "#/components/parameters/oauth_token" },
  1673. { $ref: "#/components/parameters/prettyPrint" },
  1674. { $ref: "#/components/parameters/quotaUser" },
  1675. { $ref: "#/components/parameters/uploadType" },
  1676. { $ref: "#/components/parameters/upload_protocol" },
  1677. ],
  1678. },
  1679. "/v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:sendOobCode": {
  1680. post: {
  1681. description: "Sends an out-of-band confirmation code for an account. Requests from a authenticated request can optionally return a link including the OOB code instead of sending it.",
  1682. operationId: "identitytoolkit.projects.tenants.accounts.sendOobCode",
  1683. responses: {
  1684. "200": {
  1685. description: "Successful response",
  1686. content: {
  1687. "*/*": {
  1688. schema: {
  1689. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1GetOobCodeResponse",
  1690. },
  1691. },
  1692. },
  1693. },
  1694. },
  1695. parameters: [
  1696. {
  1697. name: "targetProjectId",
  1698. in: "path",
  1699. description: "The Project ID of the Identity Platform project which the account belongs to. To specify this field, it requires a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).",
  1700. required: true,
  1701. schema: { type: "string" },
  1702. },
  1703. {
  1704. name: "tenantId",
  1705. in: "path",
  1706. description: "The tenant ID of the Identity Platform tenant the account belongs to.",
  1707. required: true,
  1708. schema: { type: "string" },
  1709. },
  1710. ],
  1711. requestBody: {
  1712. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1GetOobCodeRequest",
  1713. },
  1714. security: [
  1715. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  1716. { apiKeyQuery: [] },
  1717. { apiKeyHeader: [] },
  1718. ],
  1719. tags: ["projects"],
  1720. },
  1721. parameters: [
  1722. { $ref: "#/components/parameters/access_token" },
  1723. { $ref: "#/components/parameters/alt" },
  1724. { $ref: "#/components/parameters/callback" },
  1725. { $ref: "#/components/parameters/fields" },
  1726. { $ref: "#/components/parameters/oauth_token" },
  1727. { $ref: "#/components/parameters/prettyPrint" },
  1728. { $ref: "#/components/parameters/quotaUser" },
  1729. { $ref: "#/components/parameters/uploadType" },
  1730. { $ref: "#/components/parameters/upload_protocol" },
  1731. ],
  1732. },
  1733. "/v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:update": {
  1734. post: {
  1735. description: "Updates account-related information for the specified user by setting specific fields or applying action codes. Requests from administrators and end users are supported.",
  1736. operationId: "identitytoolkit.projects.tenants.accounts.update",
  1737. responses: {
  1738. "200": {
  1739. description: "Successful response",
  1740. content: {
  1741. "*/*": {
  1742. schema: {
  1743. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SetAccountInfoResponse",
  1744. },
  1745. },
  1746. },
  1747. },
  1748. },
  1749. parameters: [
  1750. {
  1751. name: "targetProjectId",
  1752. in: "path",
  1753. description: "The project ID for the project that the account belongs to. Specifying this field requires Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control). Requests from end users should pass an Identity Platform ID token instead.",
  1754. required: true,
  1755. schema: { type: "string" },
  1756. },
  1757. {
  1758. name: "tenantId",
  1759. in: "path",
  1760. description: "The tenant ID of the Identity Platform tenant that the account belongs to. Requests from end users should pass an Identity Platform ID token rather than setting this field.",
  1761. required: true,
  1762. schema: { type: "string" },
  1763. },
  1764. ],
  1765. requestBody: {
  1766. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1SetAccountInfoRequest",
  1767. },
  1768. security: [
  1769. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  1770. { apiKeyQuery: [] },
  1771. { apiKeyHeader: [] },
  1772. ],
  1773. tags: ["projects"],
  1774. },
  1775. parameters: [
  1776. { $ref: "#/components/parameters/access_token" },
  1777. { $ref: "#/components/parameters/alt" },
  1778. { $ref: "#/components/parameters/callback" },
  1779. { $ref: "#/components/parameters/fields" },
  1780. { $ref: "#/components/parameters/oauth_token" },
  1781. { $ref: "#/components/parameters/prettyPrint" },
  1782. { $ref: "#/components/parameters/quotaUser" },
  1783. { $ref: "#/components/parameters/uploadType" },
  1784. { $ref: "#/components/parameters/upload_protocol" },
  1785. ],
  1786. },
  1787. "/v1/projects": {
  1788. get: {
  1789. description: "Gets a project's public Identity Toolkit configuration. (Legacy) This method also supports authenticated calls from a developer to retrieve non-public configuration.",
  1790. operationId: "identitytoolkit.getProjects",
  1791. responses: {
  1792. "200": {
  1793. description: "Successful response",
  1794. content: {
  1795. "*/*": {
  1796. schema: {
  1797. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1GetProjectConfigResponse",
  1798. },
  1799. },
  1800. },
  1801. },
  1802. },
  1803. parameters: [
  1804. {
  1805. name: "androidPackageName",
  1806. in: "query",
  1807. description: "Android package name to check against the real android package name. If this field is provided, and sha1_cert_hash is not provided, the action will throw an error if this does not match the real android package name.",
  1808. schema: { type: "string" },
  1809. },
  1810. {
  1811. name: "clientId",
  1812. in: "query",
  1813. description: "The RP OAuth client ID. If set, a check will be performed to ensure that the OAuth client is valid for the retrieved project and the request rejected with a client error if not valid.",
  1814. schema: { type: "string" },
  1815. },
  1816. {
  1817. name: "delegatedProjectNumber",
  1818. in: "query",
  1819. description: "Project Number of the delegated project request. This field should only be used as part of the Firebase V1 migration.",
  1820. schema: { type: "string" },
  1821. },
  1822. {
  1823. name: "firebaseAppId",
  1824. in: "query",
  1825. description: "The Firebase app ID, for applications that use Firebase. This can be found in the Firebase console for your project. If set, a check will be performed to ensure that the app ID is valid for the retrieved project. If not valid, the request will be rejected with a client error.",
  1826. schema: { type: "string" },
  1827. },
  1828. {
  1829. name: "iosBundleId",
  1830. in: "query",
  1831. description: "iOS bundle id to check against the real ios bundle id. If this field is provided, the action will throw an error if this does not match the real iOS bundle id.",
  1832. schema: { type: "string" },
  1833. },
  1834. {
  1835. name: "projectNumber",
  1836. in: "query",
  1837. description: "Project number of the configuration to retrieve. This field is deprecated and should not be used by new integrations.",
  1838. schema: { type: "string" },
  1839. },
  1840. {
  1841. name: "returnDynamicLink",
  1842. in: "query",
  1843. description: "Whether dynamic link should be returned.",
  1844. schema: { type: "boolean" },
  1845. },
  1846. {
  1847. name: "sha1Cert",
  1848. in: "query",
  1849. description: "SHA-1 Android application cert hash. If set, a check will be performed to ensure that the cert hash is valid for the retrieved project and android_package_name.",
  1850. schema: { type: "string" },
  1851. },
  1852. ],
  1853. security: [
  1854. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  1855. { apiKeyQuery: [] },
  1856. { apiKeyHeader: [] },
  1857. ],
  1858. tags: ["v1"],
  1859. },
  1860. parameters: [
  1861. { $ref: "#/components/parameters/access_token" },
  1862. { $ref: "#/components/parameters/alt" },
  1863. { $ref: "#/components/parameters/callback" },
  1864. { $ref: "#/components/parameters/fields" },
  1865. { $ref: "#/components/parameters/oauth_token" },
  1866. { $ref: "#/components/parameters/prettyPrint" },
  1867. { $ref: "#/components/parameters/quotaUser" },
  1868. { $ref: "#/components/parameters/uploadType" },
  1869. { $ref: "#/components/parameters/upload_protocol" },
  1870. ],
  1871. },
  1872. "/v1/recaptchaParams": {
  1873. get: {
  1874. description: "Gets parameters needed for generating a reCAPTCHA challenge.",
  1875. operationId: "identitytoolkit.getRecaptchaParams",
  1876. responses: {
  1877. "200": {
  1878. description: "Successful response",
  1879. content: {
  1880. "*/*": {
  1881. schema: {
  1882. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1GetRecaptchaParamResponse",
  1883. },
  1884. },
  1885. },
  1886. },
  1887. },
  1888. security: [
  1889. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  1890. { apiKeyQuery: [] },
  1891. { apiKeyHeader: [] },
  1892. ],
  1893. tags: ["v1"],
  1894. },
  1895. parameters: [
  1896. { $ref: "#/components/parameters/access_token" },
  1897. { $ref: "#/components/parameters/alt" },
  1898. { $ref: "#/components/parameters/callback" },
  1899. { $ref: "#/components/parameters/fields" },
  1900. { $ref: "#/components/parameters/oauth_token" },
  1901. { $ref: "#/components/parameters/prettyPrint" },
  1902. { $ref: "#/components/parameters/quotaUser" },
  1903. { $ref: "#/components/parameters/uploadType" },
  1904. { $ref: "#/components/parameters/upload_protocol" },
  1905. ],
  1906. },
  1907. "/v1/sessionCookiePublicKeys": {
  1908. get: {
  1909. description: "Retrieves the set of public keys of the session cookie JSON Web Token (JWT) signer that can be used to validate the session cookie created through createSessionCookie.",
  1910. operationId: "identitytoolkit.getSessionCookiePublicKeys",
  1911. responses: {
  1912. "200": {
  1913. description: "Successful response",
  1914. content: {
  1915. "*/*": {
  1916. schema: {
  1917. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1GetSessionCookiePublicKeysResponse",
  1918. },
  1919. },
  1920. },
  1921. },
  1922. },
  1923. tags: ["v1"],
  1924. security: [{ apiKeyQuery: [] }, { apiKeyHeader: [] }],
  1925. },
  1926. parameters: [
  1927. { $ref: "#/components/parameters/access_token" },
  1928. { $ref: "#/components/parameters/alt" },
  1929. { $ref: "#/components/parameters/callback" },
  1930. { $ref: "#/components/parameters/fields" },
  1931. { $ref: "#/components/parameters/oauth_token" },
  1932. { $ref: "#/components/parameters/prettyPrint" },
  1933. { $ref: "#/components/parameters/quotaUser" },
  1934. { $ref: "#/components/parameters/uploadType" },
  1935. { $ref: "#/components/parameters/upload_protocol" },
  1936. ],
  1937. },
  1938. "/v2/accounts/mfaEnrollment:finalize": {
  1939. post: {
  1940. description: "Finishes enrolling a second factor for the user.",
  1941. operationId: "identitytoolkit.accounts.mfaEnrollment.finalize",
  1942. responses: {
  1943. "200": {
  1944. description: "Successful response",
  1945. content: {
  1946. "*/*": {
  1947. schema: {
  1948. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV2FinalizeMfaEnrollmentResponse",
  1949. },
  1950. },
  1951. },
  1952. },
  1953. },
  1954. requestBody: {
  1955. content: {
  1956. "application/json": {
  1957. schema: {
  1958. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV2FinalizeMfaEnrollmentRequest",
  1959. },
  1960. },
  1961. },
  1962. },
  1963. security: [
  1964. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  1965. { apiKeyQuery: [] },
  1966. { apiKeyHeader: [] },
  1967. ],
  1968. tags: ["accounts"],
  1969. },
  1970. parameters: [
  1971. { $ref: "#/components/parameters/access_token" },
  1972. { $ref: "#/components/parameters/alt" },
  1973. { $ref: "#/components/parameters/callback" },
  1974. { $ref: "#/components/parameters/fields" },
  1975. { $ref: "#/components/parameters/oauth_token" },
  1976. { $ref: "#/components/parameters/prettyPrint" },
  1977. { $ref: "#/components/parameters/quotaUser" },
  1978. { $ref: "#/components/parameters/uploadType" },
  1979. { $ref: "#/components/parameters/upload_protocol" },
  1980. ],
  1981. },
  1982. "/v2/accounts/mfaEnrollment:start": {
  1983. post: {
  1984. description: "Step one of the MFA enrollment process. In SMS case, this sends an SMS verification code to the user.",
  1985. operationId: "identitytoolkit.accounts.mfaEnrollment.start",
  1986. responses: {
  1987. "200": {
  1988. description: "Successful response",
  1989. content: {
  1990. "*/*": {
  1991. schema: {
  1992. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV2StartMfaEnrollmentResponse",
  1993. },
  1994. },
  1995. },
  1996. },
  1997. },
  1998. requestBody: {
  1999. content: {
  2000. "application/json": {
  2001. schema: {
  2002. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV2StartMfaEnrollmentRequest",
  2003. },
  2004. },
  2005. },
  2006. },
  2007. security: [
  2008. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2009. { apiKeyQuery: [] },
  2010. { apiKeyHeader: [] },
  2011. ],
  2012. tags: ["accounts"],
  2013. },
  2014. parameters: [
  2015. { $ref: "#/components/parameters/access_token" },
  2016. { $ref: "#/components/parameters/alt" },
  2017. { $ref: "#/components/parameters/callback" },
  2018. { $ref: "#/components/parameters/fields" },
  2019. { $ref: "#/components/parameters/oauth_token" },
  2020. { $ref: "#/components/parameters/prettyPrint" },
  2021. { $ref: "#/components/parameters/quotaUser" },
  2022. { $ref: "#/components/parameters/uploadType" },
  2023. { $ref: "#/components/parameters/upload_protocol" },
  2024. ],
  2025. },
  2026. "/v2/accounts/mfaEnrollment:withdraw": {
  2027. post: {
  2028. description: "Revokes one second factor from the enrolled second factors for an account.",
  2029. operationId: "identitytoolkit.accounts.mfaEnrollment.withdraw",
  2030. responses: {
  2031. "200": {
  2032. description: "Successful response",
  2033. content: {
  2034. "*/*": {
  2035. schema: {
  2036. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV2WithdrawMfaResponse",
  2037. },
  2038. },
  2039. },
  2040. },
  2041. },
  2042. requestBody: {
  2043. content: {
  2044. "application/json": {
  2045. schema: {
  2046. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV2WithdrawMfaRequest",
  2047. },
  2048. },
  2049. },
  2050. },
  2051. security: [
  2052. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2053. { apiKeyQuery: [] },
  2054. { apiKeyHeader: [] },
  2055. ],
  2056. tags: ["accounts"],
  2057. },
  2058. parameters: [
  2059. { $ref: "#/components/parameters/access_token" },
  2060. { $ref: "#/components/parameters/alt" },
  2061. { $ref: "#/components/parameters/callback" },
  2062. { $ref: "#/components/parameters/fields" },
  2063. { $ref: "#/components/parameters/oauth_token" },
  2064. { $ref: "#/components/parameters/prettyPrint" },
  2065. { $ref: "#/components/parameters/quotaUser" },
  2066. { $ref: "#/components/parameters/uploadType" },
  2067. { $ref: "#/components/parameters/upload_protocol" },
  2068. ],
  2069. },
  2070. "/v2/accounts/mfaSignIn:finalize": {
  2071. post: {
  2072. description: "Verifies the MFA challenge and performs sign-in",
  2073. operationId: "identitytoolkit.accounts.mfaSignIn.finalize",
  2074. responses: {
  2075. "200": {
  2076. description: "Successful response",
  2077. content: {
  2078. "*/*": {
  2079. schema: {
  2080. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV2FinalizeMfaSignInResponse",
  2081. },
  2082. },
  2083. },
  2084. },
  2085. },
  2086. requestBody: {
  2087. content: {
  2088. "application/json": {
  2089. schema: {
  2090. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV2FinalizeMfaSignInRequest",
  2091. },
  2092. },
  2093. },
  2094. },
  2095. security: [
  2096. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2097. { apiKeyQuery: [] },
  2098. { apiKeyHeader: [] },
  2099. ],
  2100. tags: ["accounts"],
  2101. },
  2102. parameters: [
  2103. { $ref: "#/components/parameters/access_token" },
  2104. { $ref: "#/components/parameters/alt" },
  2105. { $ref: "#/components/parameters/callback" },
  2106. { $ref: "#/components/parameters/fields" },
  2107. { $ref: "#/components/parameters/oauth_token" },
  2108. { $ref: "#/components/parameters/prettyPrint" },
  2109. { $ref: "#/components/parameters/quotaUser" },
  2110. { $ref: "#/components/parameters/uploadType" },
  2111. { $ref: "#/components/parameters/upload_protocol" },
  2112. ],
  2113. },
  2114. "/v2/accounts/mfaSignIn:start": {
  2115. post: {
  2116. description: "Sends the MFA challenge",
  2117. operationId: "identitytoolkit.accounts.mfaSignIn.start",
  2118. responses: {
  2119. "200": {
  2120. description: "Successful response",
  2121. content: {
  2122. "*/*": {
  2123. schema: {
  2124. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV2StartMfaSignInResponse",
  2125. },
  2126. },
  2127. },
  2128. },
  2129. },
  2130. requestBody: {
  2131. content: {
  2132. "application/json": {
  2133. schema: {
  2134. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV2StartMfaSignInRequest",
  2135. },
  2136. },
  2137. },
  2138. },
  2139. security: [
  2140. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2141. { apiKeyQuery: [] },
  2142. { apiKeyHeader: [] },
  2143. ],
  2144. tags: ["accounts"],
  2145. },
  2146. parameters: [
  2147. { $ref: "#/components/parameters/access_token" },
  2148. { $ref: "#/components/parameters/alt" },
  2149. { $ref: "#/components/parameters/callback" },
  2150. { $ref: "#/components/parameters/fields" },
  2151. { $ref: "#/components/parameters/oauth_token" },
  2152. { $ref: "#/components/parameters/prettyPrint" },
  2153. { $ref: "#/components/parameters/quotaUser" },
  2154. { $ref: "#/components/parameters/uploadType" },
  2155. { $ref: "#/components/parameters/upload_protocol" },
  2156. ],
  2157. },
  2158. "/v2/defaultSupportedIdps": {
  2159. get: {
  2160. description: "List all default supported Idps.",
  2161. operationId: "identitytoolkit.defaultSupportedIdps.list",
  2162. responses: {
  2163. "200": {
  2164. description: "Successful response",
  2165. content: {
  2166. "*/*": {
  2167. schema: {
  2168. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2ListDefaultSupportedIdpsResponse",
  2169. },
  2170. },
  2171. },
  2172. },
  2173. },
  2174. parameters: [
  2175. {
  2176. name: "pageSize",
  2177. in: "query",
  2178. description: "The maximum number of items to return.",
  2179. schema: { type: "integer" },
  2180. },
  2181. {
  2182. name: "pageToken",
  2183. in: "query",
  2184. description: "The next_page_token value returned from a previous List request, if any.",
  2185. schema: { type: "string" },
  2186. },
  2187. ],
  2188. security: [
  2189. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2190. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  2191. { apiKeyQuery: [] },
  2192. { apiKeyHeader: [] },
  2193. ],
  2194. tags: ["defaultSupportedIdps"],
  2195. },
  2196. parameters: [
  2197. { $ref: "#/components/parameters/access_token" },
  2198. { $ref: "#/components/parameters/alt" },
  2199. { $ref: "#/components/parameters/callback" },
  2200. { $ref: "#/components/parameters/fields" },
  2201. { $ref: "#/components/parameters/oauth_token" },
  2202. { $ref: "#/components/parameters/prettyPrint" },
  2203. { $ref: "#/components/parameters/quotaUser" },
  2204. { $ref: "#/components/parameters/uploadType" },
  2205. { $ref: "#/components/parameters/upload_protocol" },
  2206. ],
  2207. },
  2208. "/v2/projects/{targetProjectId}/config": {
  2209. get: {
  2210. description: "Retrieve an Identity Toolkit project configuration.",
  2211. operationId: "identitytoolkit.projects.getConfig",
  2212. responses: {
  2213. "200": {
  2214. description: "Successful response",
  2215. content: {
  2216. "*/*": {
  2217. schema: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2Config" },
  2218. },
  2219. },
  2220. },
  2221. },
  2222. parameters: [
  2223. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2224. ],
  2225. security: [
  2226. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2227. { apiKeyQuery: [] },
  2228. { apiKeyHeader: [] },
  2229. ],
  2230. tags: ["projects"],
  2231. },
  2232. patch: {
  2233. description: "Update an Identity Toolkit project configuration.",
  2234. operationId: "identitytoolkit.projects.updateConfig",
  2235. responses: {
  2236. "200": {
  2237. description: "Successful response",
  2238. content: {
  2239. "*/*": {
  2240. schema: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2Config" },
  2241. },
  2242. },
  2243. },
  2244. },
  2245. parameters: [
  2246. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2247. {
  2248. name: "updateMask",
  2249. in: "query",
  2250. description: "The update mask applies to the resource. Fields set in the config but not included in this update mask will be ignored. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask",
  2251. schema: { type: "string" },
  2252. },
  2253. ],
  2254. requestBody: {
  2255. content: {
  2256. "application/json": {
  2257. schema: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2Config" },
  2258. },
  2259. },
  2260. },
  2261. security: [
  2262. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2263. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  2264. { apiKeyQuery: [] },
  2265. { apiKeyHeader: [] },
  2266. ],
  2267. tags: ["projects"],
  2268. },
  2269. parameters: [
  2270. { $ref: "#/components/parameters/access_token" },
  2271. { $ref: "#/components/parameters/alt" },
  2272. { $ref: "#/components/parameters/callback" },
  2273. { $ref: "#/components/parameters/fields" },
  2274. { $ref: "#/components/parameters/oauth_token" },
  2275. { $ref: "#/components/parameters/prettyPrint" },
  2276. { $ref: "#/components/parameters/quotaUser" },
  2277. { $ref: "#/components/parameters/uploadType" },
  2278. { $ref: "#/components/parameters/upload_protocol" },
  2279. ],
  2280. },
  2281. "/v2/projects/{targetProjectId}/defaultSupportedIdpConfigs": {
  2282. post: {
  2283. description: "Create a default supported Idp configuration for an Identity Toolkit project.",
  2284. operationId: "identitytoolkit.projects.defaultSupportedIdpConfigs.create",
  2285. responses: {
  2286. "200": {
  2287. description: "Successful response",
  2288. content: {
  2289. "*/*": {
  2290. schema: {
  2291. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig",
  2292. },
  2293. },
  2294. },
  2295. },
  2296. },
  2297. parameters: [
  2298. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2299. {
  2300. name: "idpId",
  2301. in: "query",
  2302. description: "The id of the Idp to create a config for. Call ListDefaultSupportedIdps for list of all default supported Idps.",
  2303. schema: { type: "string" },
  2304. },
  2305. ],
  2306. requestBody: {
  2307. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig",
  2308. },
  2309. security: [
  2310. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2311. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  2312. { apiKeyQuery: [] },
  2313. { apiKeyHeader: [] },
  2314. ],
  2315. tags: ["projects"],
  2316. },
  2317. get: {
  2318. description: "List all default supported Idp configurations for an Identity Toolkit project.",
  2319. operationId: "identitytoolkit.projects.defaultSupportedIdpConfigs.list",
  2320. responses: {
  2321. "200": {
  2322. description: "Successful response",
  2323. content: {
  2324. "*/*": {
  2325. schema: {
  2326. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2ListDefaultSupportedIdpConfigsResponse",
  2327. },
  2328. },
  2329. },
  2330. },
  2331. },
  2332. parameters: [
  2333. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2334. {
  2335. name: "pageSize",
  2336. in: "query",
  2337. description: "The maximum number of items to return.",
  2338. schema: { type: "integer" },
  2339. },
  2340. {
  2341. name: "pageToken",
  2342. in: "query",
  2343. description: "The next_page_token value returned from a previous List request, if any.",
  2344. schema: { type: "string" },
  2345. },
  2346. ],
  2347. security: [
  2348. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2349. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  2350. { apiKeyQuery: [] },
  2351. { apiKeyHeader: [] },
  2352. ],
  2353. tags: ["projects"],
  2354. },
  2355. parameters: [
  2356. { $ref: "#/components/parameters/access_token" },
  2357. { $ref: "#/components/parameters/alt" },
  2358. { $ref: "#/components/parameters/callback" },
  2359. { $ref: "#/components/parameters/fields" },
  2360. { $ref: "#/components/parameters/oauth_token" },
  2361. { $ref: "#/components/parameters/prettyPrint" },
  2362. { $ref: "#/components/parameters/quotaUser" },
  2363. { $ref: "#/components/parameters/uploadType" },
  2364. { $ref: "#/components/parameters/upload_protocol" },
  2365. ],
  2366. },
  2367. "/v2/projects/{targetProjectId}/defaultSupportedIdpConfigs/{defaultSupportedIdpConfigsId}": {
  2368. delete: {
  2369. description: "Delete a default supported Idp configuration for an Identity Toolkit project.",
  2370. operationId: "identitytoolkit.projects.defaultSupportedIdpConfigs.delete",
  2371. responses: {
  2372. "200": {
  2373. description: "Successful response",
  2374. content: { "*/*": { schema: { $ref: "#/components/schemas/GoogleProtobufEmpty" } } },
  2375. },
  2376. },
  2377. parameters: [
  2378. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2379. {
  2380. name: "defaultSupportedIdpConfigsId",
  2381. in: "path",
  2382. required: true,
  2383. schema: { type: "string" },
  2384. },
  2385. ],
  2386. security: [
  2387. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2388. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  2389. { apiKeyQuery: [] },
  2390. { apiKeyHeader: [] },
  2391. ],
  2392. tags: ["projects"],
  2393. },
  2394. get: {
  2395. description: "Retrieve a default supported Idp configuration for an Identity Toolkit project.",
  2396. operationId: "identitytoolkit.projects.defaultSupportedIdpConfigs.get",
  2397. responses: {
  2398. "200": {
  2399. description: "Successful response",
  2400. content: {
  2401. "*/*": {
  2402. schema: {
  2403. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig",
  2404. },
  2405. },
  2406. },
  2407. },
  2408. },
  2409. parameters: [
  2410. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2411. {
  2412. name: "defaultSupportedIdpConfigsId",
  2413. in: "path",
  2414. required: true,
  2415. schema: { type: "string" },
  2416. },
  2417. ],
  2418. security: [
  2419. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2420. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  2421. { apiKeyQuery: [] },
  2422. { apiKeyHeader: [] },
  2423. ],
  2424. tags: ["projects"],
  2425. },
  2426. patch: {
  2427. description: "Update a default supported Idp configuration for an Identity Toolkit project.",
  2428. operationId: "identitytoolkit.projects.defaultSupportedIdpConfigs.patch",
  2429. responses: {
  2430. "200": {
  2431. description: "Successful response",
  2432. content: {
  2433. "*/*": {
  2434. schema: {
  2435. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig",
  2436. },
  2437. },
  2438. },
  2439. },
  2440. },
  2441. parameters: [
  2442. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2443. {
  2444. name: "defaultSupportedIdpConfigsId",
  2445. in: "path",
  2446. required: true,
  2447. schema: { type: "string" },
  2448. },
  2449. {
  2450. name: "updateMask",
  2451. in: "query",
  2452. description: "The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask",
  2453. schema: { type: "string" },
  2454. },
  2455. ],
  2456. requestBody: {
  2457. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig",
  2458. },
  2459. security: [
  2460. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2461. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  2462. { apiKeyQuery: [] },
  2463. { apiKeyHeader: [] },
  2464. ],
  2465. tags: ["projects"],
  2466. },
  2467. parameters: [
  2468. { $ref: "#/components/parameters/access_token" },
  2469. { $ref: "#/components/parameters/alt" },
  2470. { $ref: "#/components/parameters/callback" },
  2471. { $ref: "#/components/parameters/fields" },
  2472. { $ref: "#/components/parameters/oauth_token" },
  2473. { $ref: "#/components/parameters/prettyPrint" },
  2474. { $ref: "#/components/parameters/quotaUser" },
  2475. { $ref: "#/components/parameters/uploadType" },
  2476. { $ref: "#/components/parameters/upload_protocol" },
  2477. ],
  2478. },
  2479. "/v2/projects/{targetProjectId}/identityPlatform:initializeAuth": {
  2480. post: {
  2481. description: "Initialize Identity Platform for a Cloud project. Identity Platform is an end-to-end authentication system for third-party users to access your apps and services. These could include mobile/web apps, games, APIs and beyond. This is the publicly available variant of EnableIdentityPlatform that is only available to billing-enabled projects.",
  2482. operationId: "identitytoolkit.projects.identityPlatform.initializeAuth",
  2483. responses: {
  2484. "200": {
  2485. description: "Successful response",
  2486. content: {
  2487. "*/*": {
  2488. schema: {
  2489. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2InitializeIdentityPlatformResponse",
  2490. },
  2491. },
  2492. },
  2493. },
  2494. },
  2495. parameters: [
  2496. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2497. ],
  2498. requestBody: {
  2499. content: {
  2500. "application/json": {
  2501. schema: {
  2502. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2InitializeIdentityPlatformRequest",
  2503. },
  2504. },
  2505. },
  2506. },
  2507. security: [
  2508. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2509. { apiKeyQuery: [] },
  2510. { apiKeyHeader: [] },
  2511. ],
  2512. tags: ["projects"],
  2513. },
  2514. parameters: [
  2515. { $ref: "#/components/parameters/access_token" },
  2516. { $ref: "#/components/parameters/alt" },
  2517. { $ref: "#/components/parameters/callback" },
  2518. { $ref: "#/components/parameters/fields" },
  2519. { $ref: "#/components/parameters/oauth_token" },
  2520. { $ref: "#/components/parameters/prettyPrint" },
  2521. { $ref: "#/components/parameters/quotaUser" },
  2522. { $ref: "#/components/parameters/uploadType" },
  2523. { $ref: "#/components/parameters/upload_protocol" },
  2524. ],
  2525. },
  2526. "/v2/projects/{targetProjectId}/inboundSamlConfigs": {
  2527. post: {
  2528. description: "Create an inbound SAML configuration for an Identity Toolkit project.",
  2529. operationId: "identitytoolkit.projects.inboundSamlConfigs.create",
  2530. responses: {
  2531. "200": {
  2532. description: "Successful response",
  2533. content: {
  2534. "*/*": {
  2535. schema: {
  2536. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig",
  2537. },
  2538. },
  2539. },
  2540. },
  2541. },
  2542. parameters: [
  2543. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2544. {
  2545. name: "inboundSamlConfigId",
  2546. in: "query",
  2547. description: "The id to use for this config.",
  2548. schema: { type: "string" },
  2549. },
  2550. ],
  2551. requestBody: {
  2552. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig",
  2553. },
  2554. security: [
  2555. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2556. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  2557. { apiKeyQuery: [] },
  2558. { apiKeyHeader: [] },
  2559. ],
  2560. tags: ["projects"],
  2561. },
  2562. get: {
  2563. description: "List all inbound SAML configurations for an Identity Toolkit project.",
  2564. operationId: "identitytoolkit.projects.inboundSamlConfigs.list",
  2565. responses: {
  2566. "200": {
  2567. description: "Successful response",
  2568. content: {
  2569. "*/*": {
  2570. schema: {
  2571. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2ListInboundSamlConfigsResponse",
  2572. },
  2573. },
  2574. },
  2575. },
  2576. },
  2577. parameters: [
  2578. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2579. {
  2580. name: "pageSize",
  2581. in: "query",
  2582. description: "The maximum number of items to return.",
  2583. schema: { type: "integer" },
  2584. },
  2585. {
  2586. name: "pageToken",
  2587. in: "query",
  2588. description: "The next_page_token value returned from a previous List request, if any.",
  2589. schema: { type: "string" },
  2590. },
  2591. ],
  2592. security: [
  2593. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2594. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  2595. { apiKeyQuery: [] },
  2596. { apiKeyHeader: [] },
  2597. ],
  2598. tags: ["projects"],
  2599. },
  2600. parameters: [
  2601. { $ref: "#/components/parameters/access_token" },
  2602. { $ref: "#/components/parameters/alt" },
  2603. { $ref: "#/components/parameters/callback" },
  2604. { $ref: "#/components/parameters/fields" },
  2605. { $ref: "#/components/parameters/oauth_token" },
  2606. { $ref: "#/components/parameters/prettyPrint" },
  2607. { $ref: "#/components/parameters/quotaUser" },
  2608. { $ref: "#/components/parameters/uploadType" },
  2609. { $ref: "#/components/parameters/upload_protocol" },
  2610. ],
  2611. },
  2612. "/v2/projects/{targetProjectId}/inboundSamlConfigs/{inboundSamlConfigsId}": {
  2613. delete: {
  2614. description: "Delete an inbound SAML configuration for an Identity Toolkit project.",
  2615. operationId: "identitytoolkit.projects.inboundSamlConfigs.delete",
  2616. responses: {
  2617. "200": {
  2618. description: "Successful response",
  2619. content: { "*/*": { schema: { $ref: "#/components/schemas/GoogleProtobufEmpty" } } },
  2620. },
  2621. },
  2622. parameters: [
  2623. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2624. { name: "inboundSamlConfigsId", in: "path", required: true, schema: { type: "string" } },
  2625. ],
  2626. security: [
  2627. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2628. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  2629. { apiKeyQuery: [] },
  2630. { apiKeyHeader: [] },
  2631. ],
  2632. tags: ["projects"],
  2633. },
  2634. get: {
  2635. description: "Retrieve an inbound SAML configuration for an Identity Toolkit project.",
  2636. operationId: "identitytoolkit.projects.inboundSamlConfigs.get",
  2637. responses: {
  2638. "200": {
  2639. description: "Successful response",
  2640. content: {
  2641. "*/*": {
  2642. schema: {
  2643. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig",
  2644. },
  2645. },
  2646. },
  2647. },
  2648. },
  2649. parameters: [
  2650. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2651. { name: "inboundSamlConfigsId", in: "path", required: true, schema: { type: "string" } },
  2652. ],
  2653. security: [
  2654. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2655. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  2656. { apiKeyQuery: [] },
  2657. { apiKeyHeader: [] },
  2658. ],
  2659. tags: ["projects"],
  2660. },
  2661. patch: {
  2662. description: "Update an inbound SAML configuration for an Identity Toolkit project.",
  2663. operationId: "identitytoolkit.projects.inboundSamlConfigs.patch",
  2664. responses: {
  2665. "200": {
  2666. description: "Successful response",
  2667. content: {
  2668. "*/*": {
  2669. schema: {
  2670. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig",
  2671. },
  2672. },
  2673. },
  2674. },
  2675. },
  2676. parameters: [
  2677. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2678. { name: "inboundSamlConfigsId", in: "path", required: true, schema: { type: "string" } },
  2679. {
  2680. name: "updateMask",
  2681. in: "query",
  2682. description: "The update mask applies to the resource. Empty update mask will result in updating nothing. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask",
  2683. schema: { type: "string" },
  2684. },
  2685. ],
  2686. requestBody: {
  2687. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig",
  2688. },
  2689. security: [
  2690. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2691. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  2692. { apiKeyQuery: [] },
  2693. { apiKeyHeader: [] },
  2694. ],
  2695. tags: ["projects"],
  2696. },
  2697. parameters: [
  2698. { $ref: "#/components/parameters/access_token" },
  2699. { $ref: "#/components/parameters/alt" },
  2700. { $ref: "#/components/parameters/callback" },
  2701. { $ref: "#/components/parameters/fields" },
  2702. { $ref: "#/components/parameters/oauth_token" },
  2703. { $ref: "#/components/parameters/prettyPrint" },
  2704. { $ref: "#/components/parameters/quotaUser" },
  2705. { $ref: "#/components/parameters/uploadType" },
  2706. { $ref: "#/components/parameters/upload_protocol" },
  2707. ],
  2708. },
  2709. "/v2/projects/{targetProjectId}/oauthIdpConfigs": {
  2710. post: {
  2711. description: "Create an Oidc Idp configuration for an Identity Toolkit project.",
  2712. operationId: "identitytoolkit.projects.oauthIdpConfigs.create",
  2713. responses: {
  2714. "200": {
  2715. description: "Successful response",
  2716. content: {
  2717. "*/*": {
  2718. schema: {
  2719. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig",
  2720. },
  2721. },
  2722. },
  2723. },
  2724. },
  2725. parameters: [
  2726. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2727. {
  2728. name: "oauthIdpConfigId",
  2729. in: "query",
  2730. description: "The id to use for this config.",
  2731. schema: { type: "string" },
  2732. },
  2733. ],
  2734. requestBody: {
  2735. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig",
  2736. },
  2737. security: [
  2738. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2739. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  2740. { apiKeyQuery: [] },
  2741. { apiKeyHeader: [] },
  2742. ],
  2743. tags: ["projects"],
  2744. },
  2745. get: {
  2746. description: "List all Oidc Idp configurations for an Identity Toolkit project.",
  2747. operationId: "identitytoolkit.projects.oauthIdpConfigs.list",
  2748. responses: {
  2749. "200": {
  2750. description: "Successful response",
  2751. content: {
  2752. "*/*": {
  2753. schema: {
  2754. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2ListOAuthIdpConfigsResponse",
  2755. },
  2756. },
  2757. },
  2758. },
  2759. },
  2760. parameters: [
  2761. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2762. {
  2763. name: "pageSize",
  2764. in: "query",
  2765. description: "The maximum number of items to return.",
  2766. schema: { type: "integer" },
  2767. },
  2768. {
  2769. name: "pageToken",
  2770. in: "query",
  2771. description: "The next_page_token value returned from a previous List request, if any.",
  2772. schema: { type: "string" },
  2773. },
  2774. ],
  2775. security: [
  2776. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2777. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  2778. { apiKeyQuery: [] },
  2779. { apiKeyHeader: [] },
  2780. ],
  2781. tags: ["projects"],
  2782. },
  2783. parameters: [
  2784. { $ref: "#/components/parameters/access_token" },
  2785. { $ref: "#/components/parameters/alt" },
  2786. { $ref: "#/components/parameters/callback" },
  2787. { $ref: "#/components/parameters/fields" },
  2788. { $ref: "#/components/parameters/oauth_token" },
  2789. { $ref: "#/components/parameters/prettyPrint" },
  2790. { $ref: "#/components/parameters/quotaUser" },
  2791. { $ref: "#/components/parameters/uploadType" },
  2792. { $ref: "#/components/parameters/upload_protocol" },
  2793. ],
  2794. },
  2795. "/v2/projects/{targetProjectId}/oauthIdpConfigs/{oauthIdpConfigsId}": {
  2796. delete: {
  2797. description: "Delete an Oidc Idp configuration for an Identity Toolkit project.",
  2798. operationId: "identitytoolkit.projects.oauthIdpConfigs.delete",
  2799. responses: {
  2800. "200": {
  2801. description: "Successful response",
  2802. content: { "*/*": { schema: { $ref: "#/components/schemas/GoogleProtobufEmpty" } } },
  2803. },
  2804. },
  2805. parameters: [
  2806. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2807. { name: "oauthIdpConfigsId", in: "path", required: true, schema: { type: "string" } },
  2808. ],
  2809. security: [
  2810. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2811. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  2812. { apiKeyQuery: [] },
  2813. { apiKeyHeader: [] },
  2814. ],
  2815. tags: ["projects"],
  2816. },
  2817. get: {
  2818. description: "Retrieve an Oidc Idp configuration for an Identity Toolkit project.",
  2819. operationId: "identitytoolkit.projects.oauthIdpConfigs.get",
  2820. responses: {
  2821. "200": {
  2822. description: "Successful response",
  2823. content: {
  2824. "*/*": {
  2825. schema: {
  2826. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig",
  2827. },
  2828. },
  2829. },
  2830. },
  2831. },
  2832. parameters: [
  2833. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2834. { name: "oauthIdpConfigsId", in: "path", required: true, schema: { type: "string" } },
  2835. ],
  2836. security: [
  2837. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2838. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  2839. { apiKeyQuery: [] },
  2840. { apiKeyHeader: [] },
  2841. ],
  2842. tags: ["projects"],
  2843. },
  2844. patch: {
  2845. description: "Update an Oidc Idp configuration for an Identity Toolkit project.",
  2846. operationId: "identitytoolkit.projects.oauthIdpConfigs.patch",
  2847. responses: {
  2848. "200": {
  2849. description: "Successful response",
  2850. content: {
  2851. "*/*": {
  2852. schema: {
  2853. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig",
  2854. },
  2855. },
  2856. },
  2857. },
  2858. },
  2859. parameters: [
  2860. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2861. { name: "oauthIdpConfigsId", in: "path", required: true, schema: { type: "string" } },
  2862. {
  2863. name: "updateMask",
  2864. in: "query",
  2865. description: "The update mask applies to the resource. Empty update mask will result in updating nothing. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask",
  2866. schema: { type: "string" },
  2867. },
  2868. ],
  2869. requestBody: {
  2870. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig",
  2871. },
  2872. security: [
  2873. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2874. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  2875. { apiKeyQuery: [] },
  2876. { apiKeyHeader: [] },
  2877. ],
  2878. tags: ["projects"],
  2879. },
  2880. parameters: [
  2881. { $ref: "#/components/parameters/access_token" },
  2882. { $ref: "#/components/parameters/alt" },
  2883. { $ref: "#/components/parameters/callback" },
  2884. { $ref: "#/components/parameters/fields" },
  2885. { $ref: "#/components/parameters/oauth_token" },
  2886. { $ref: "#/components/parameters/prettyPrint" },
  2887. { $ref: "#/components/parameters/quotaUser" },
  2888. { $ref: "#/components/parameters/uploadType" },
  2889. { $ref: "#/components/parameters/upload_protocol" },
  2890. ],
  2891. },
  2892. "/v2/projects/{targetProjectId}/tenants": {
  2893. post: {
  2894. description: "Create a tenant. Requires write permission on the Agent project.",
  2895. operationId: "identitytoolkit.projects.tenants.create",
  2896. responses: {
  2897. "200": {
  2898. description: "Successful response",
  2899. content: {
  2900. "*/*": {
  2901. schema: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2Tenant" },
  2902. },
  2903. },
  2904. },
  2905. },
  2906. parameters: [
  2907. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2908. ],
  2909. requestBody: { $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitAdminV2Tenant" },
  2910. security: [
  2911. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2912. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  2913. { apiKeyQuery: [] },
  2914. { apiKeyHeader: [] },
  2915. ],
  2916. tags: ["projects"],
  2917. },
  2918. get: {
  2919. description: "List tenants under the given agent project. Requires read permission on the Agent project.",
  2920. operationId: "identitytoolkit.projects.tenants.list",
  2921. responses: {
  2922. "200": {
  2923. description: "Successful response",
  2924. content: {
  2925. "*/*": {
  2926. schema: {
  2927. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2ListTenantsResponse",
  2928. },
  2929. },
  2930. },
  2931. },
  2932. },
  2933. parameters: [
  2934. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2935. {
  2936. name: "pageSize",
  2937. in: "query",
  2938. description: "The maximum number of results to return, capped at 1000. If not specified, the default value is 20.",
  2939. schema: { type: "integer" },
  2940. },
  2941. {
  2942. name: "pageToken",
  2943. in: "query",
  2944. description: "The pagination token from the response of a previous request.",
  2945. schema: { type: "string" },
  2946. },
  2947. ],
  2948. security: [
  2949. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2950. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  2951. { apiKeyQuery: [] },
  2952. { apiKeyHeader: [] },
  2953. ],
  2954. tags: ["projects"],
  2955. },
  2956. parameters: [
  2957. { $ref: "#/components/parameters/access_token" },
  2958. { $ref: "#/components/parameters/alt" },
  2959. { $ref: "#/components/parameters/callback" },
  2960. { $ref: "#/components/parameters/fields" },
  2961. { $ref: "#/components/parameters/oauth_token" },
  2962. { $ref: "#/components/parameters/prettyPrint" },
  2963. { $ref: "#/components/parameters/quotaUser" },
  2964. { $ref: "#/components/parameters/uploadType" },
  2965. { $ref: "#/components/parameters/upload_protocol" },
  2966. ],
  2967. },
  2968. "/v2/projects/{targetProjectId}/tenants/{tenantId}": {
  2969. delete: {
  2970. description: "Delete a tenant. Requires write permission on the Agent project.",
  2971. operationId: "identitytoolkit.projects.tenants.delete",
  2972. responses: {
  2973. "200": {
  2974. description: "Successful response",
  2975. content: { "*/*": { schema: { $ref: "#/components/schemas/GoogleProtobufEmpty" } } },
  2976. },
  2977. },
  2978. parameters: [
  2979. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  2980. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  2981. ],
  2982. security: [
  2983. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  2984. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  2985. { apiKeyQuery: [] },
  2986. { apiKeyHeader: [] },
  2987. ],
  2988. tags: ["projects"],
  2989. },
  2990. get: {
  2991. description: "Get a tenant. Requires read permission on the Tenant resource.",
  2992. operationId: "identitytoolkit.projects.tenants.get",
  2993. responses: {
  2994. "200": {
  2995. description: "Successful response",
  2996. content: {
  2997. "*/*": {
  2998. schema: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2Tenant" },
  2999. },
  3000. },
  3001. },
  3002. },
  3003. parameters: [
  3004. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  3005. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  3006. ],
  3007. security: [
  3008. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  3009. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  3010. { apiKeyQuery: [] },
  3011. { apiKeyHeader: [] },
  3012. ],
  3013. tags: ["projects"],
  3014. },
  3015. patch: {
  3016. description: "Update a tenant. Requires write permission on the Tenant resource.",
  3017. operationId: "identitytoolkit.projects.tenants.patch",
  3018. responses: {
  3019. "200": {
  3020. description: "Successful response",
  3021. content: {
  3022. "*/*": {
  3023. schema: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2Tenant" },
  3024. },
  3025. },
  3026. },
  3027. },
  3028. parameters: [
  3029. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  3030. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  3031. {
  3032. name: "updateMask",
  3033. in: "query",
  3034. description: "If provided, only update fields set in the update mask. Otherwise, all settable fields will be updated. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask",
  3035. schema: { type: "string" },
  3036. },
  3037. ],
  3038. requestBody: { $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitAdminV2Tenant" },
  3039. security: [
  3040. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  3041. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  3042. { apiKeyQuery: [] },
  3043. { apiKeyHeader: [] },
  3044. ],
  3045. tags: ["projects"],
  3046. },
  3047. parameters: [
  3048. { $ref: "#/components/parameters/access_token" },
  3049. { $ref: "#/components/parameters/alt" },
  3050. { $ref: "#/components/parameters/callback" },
  3051. { $ref: "#/components/parameters/fields" },
  3052. { $ref: "#/components/parameters/oauth_token" },
  3053. { $ref: "#/components/parameters/prettyPrint" },
  3054. { $ref: "#/components/parameters/quotaUser" },
  3055. { $ref: "#/components/parameters/uploadType" },
  3056. { $ref: "#/components/parameters/upload_protocol" },
  3057. ],
  3058. },
  3059. "/v2/projects/{targetProjectId}/tenants/{tenantId}:getIamPolicy": {
  3060. post: {
  3061. description: "Gets the access control policy for a resource. An error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. Caller must have the right Google IAM permission on the resource.",
  3062. operationId: "identitytoolkit.projects.tenants.getIamPolicy",
  3063. responses: {
  3064. "200": {
  3065. description: "Successful response",
  3066. content: { "*/*": { schema: { $ref: "#/components/schemas/GoogleIamV1Policy" } } },
  3067. },
  3068. },
  3069. parameters: [
  3070. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  3071. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  3072. ],
  3073. requestBody: {
  3074. content: {
  3075. "application/json": {
  3076. schema: { $ref: "#/components/schemas/GoogleIamV1GetIamPolicyRequest" },
  3077. },
  3078. },
  3079. },
  3080. security: [
  3081. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  3082. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  3083. { apiKeyQuery: [] },
  3084. { apiKeyHeader: [] },
  3085. ],
  3086. tags: ["projects"],
  3087. },
  3088. parameters: [
  3089. { $ref: "#/components/parameters/access_token" },
  3090. { $ref: "#/components/parameters/alt" },
  3091. { $ref: "#/components/parameters/callback" },
  3092. { $ref: "#/components/parameters/fields" },
  3093. { $ref: "#/components/parameters/oauth_token" },
  3094. { $ref: "#/components/parameters/prettyPrint" },
  3095. { $ref: "#/components/parameters/quotaUser" },
  3096. { $ref: "#/components/parameters/uploadType" },
  3097. { $ref: "#/components/parameters/upload_protocol" },
  3098. ],
  3099. },
  3100. "/v2/projects/{targetProjectId}/tenants/{tenantId}:setIamPolicy": {
  3101. post: {
  3102. description: "Sets the access control policy for a resource. If the policy exists, it is replaced. Caller must have the right Google IAM permission on the resource.",
  3103. operationId: "identitytoolkit.projects.tenants.setIamPolicy",
  3104. responses: {
  3105. "200": {
  3106. description: "Successful response",
  3107. content: { "*/*": { schema: { $ref: "#/components/schemas/GoogleIamV1Policy" } } },
  3108. },
  3109. },
  3110. parameters: [
  3111. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  3112. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  3113. ],
  3114. requestBody: {
  3115. content: {
  3116. "application/json": {
  3117. schema: { $ref: "#/components/schemas/GoogleIamV1SetIamPolicyRequest" },
  3118. },
  3119. },
  3120. },
  3121. security: [
  3122. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  3123. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  3124. { apiKeyQuery: [] },
  3125. { apiKeyHeader: [] },
  3126. ],
  3127. tags: ["projects"],
  3128. },
  3129. parameters: [
  3130. { $ref: "#/components/parameters/access_token" },
  3131. { $ref: "#/components/parameters/alt" },
  3132. { $ref: "#/components/parameters/callback" },
  3133. { $ref: "#/components/parameters/fields" },
  3134. { $ref: "#/components/parameters/oauth_token" },
  3135. { $ref: "#/components/parameters/prettyPrint" },
  3136. { $ref: "#/components/parameters/quotaUser" },
  3137. { $ref: "#/components/parameters/uploadType" },
  3138. { $ref: "#/components/parameters/upload_protocol" },
  3139. ],
  3140. },
  3141. "/v2/projects/{targetProjectId}/tenants/{tenantId}:testIamPermissions": {
  3142. post: {
  3143. description: "Returns the caller's permissions on a resource. An error is returned if the resource does not exist. A caller is not required to have Google IAM permission to make this request.",
  3144. operationId: "identitytoolkit.projects.tenants.testIamPermissions",
  3145. responses: {
  3146. "200": {
  3147. description: "Successful response",
  3148. content: {
  3149. "*/*": {
  3150. schema: { $ref: "#/components/schemas/GoogleIamV1TestIamPermissionsResponse" },
  3151. },
  3152. },
  3153. },
  3154. },
  3155. parameters: [
  3156. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  3157. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  3158. ],
  3159. requestBody: {
  3160. content: {
  3161. "application/json": {
  3162. schema: { $ref: "#/components/schemas/GoogleIamV1TestIamPermissionsRequest" },
  3163. },
  3164. },
  3165. },
  3166. security: [
  3167. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  3168. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  3169. { apiKeyQuery: [] },
  3170. { apiKeyHeader: [] },
  3171. ],
  3172. tags: ["projects"],
  3173. },
  3174. parameters: [
  3175. { $ref: "#/components/parameters/access_token" },
  3176. { $ref: "#/components/parameters/alt" },
  3177. { $ref: "#/components/parameters/callback" },
  3178. { $ref: "#/components/parameters/fields" },
  3179. { $ref: "#/components/parameters/oauth_token" },
  3180. { $ref: "#/components/parameters/prettyPrint" },
  3181. { $ref: "#/components/parameters/quotaUser" },
  3182. { $ref: "#/components/parameters/uploadType" },
  3183. { $ref: "#/components/parameters/upload_protocol" },
  3184. ],
  3185. },
  3186. "/v2/projects/{targetProjectId}/tenants/{tenantId}/defaultSupportedIdpConfigs": {
  3187. post: {
  3188. description: "Create a default supported Idp configuration for an Identity Toolkit project.",
  3189. operationId: "identitytoolkit.projects.tenants.defaultSupportedIdpConfigs.create",
  3190. responses: {
  3191. "200": {
  3192. description: "Successful response",
  3193. content: {
  3194. "*/*": {
  3195. schema: {
  3196. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig",
  3197. },
  3198. },
  3199. },
  3200. },
  3201. },
  3202. parameters: [
  3203. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  3204. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  3205. {
  3206. name: "idpId",
  3207. in: "query",
  3208. description: "The id of the Idp to create a config for. Call ListDefaultSupportedIdps for list of all default supported Idps.",
  3209. schema: { type: "string" },
  3210. },
  3211. ],
  3212. requestBody: {
  3213. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig",
  3214. },
  3215. security: [
  3216. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  3217. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  3218. { apiKeyQuery: [] },
  3219. { apiKeyHeader: [] },
  3220. ],
  3221. tags: ["projects"],
  3222. },
  3223. get: {
  3224. description: "List all default supported Idp configurations for an Identity Toolkit project.",
  3225. operationId: "identitytoolkit.projects.tenants.defaultSupportedIdpConfigs.list",
  3226. responses: {
  3227. "200": {
  3228. description: "Successful response",
  3229. content: {
  3230. "*/*": {
  3231. schema: {
  3232. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2ListDefaultSupportedIdpConfigsResponse",
  3233. },
  3234. },
  3235. },
  3236. },
  3237. },
  3238. parameters: [
  3239. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  3240. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  3241. {
  3242. name: "pageSize",
  3243. in: "query",
  3244. description: "The maximum number of items to return.",
  3245. schema: { type: "integer" },
  3246. },
  3247. {
  3248. name: "pageToken",
  3249. in: "query",
  3250. description: "The next_page_token value returned from a previous List request, if any.",
  3251. schema: { type: "string" },
  3252. },
  3253. ],
  3254. security: [
  3255. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  3256. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  3257. { apiKeyQuery: [] },
  3258. { apiKeyHeader: [] },
  3259. ],
  3260. tags: ["projects"],
  3261. },
  3262. parameters: [
  3263. { $ref: "#/components/parameters/access_token" },
  3264. { $ref: "#/components/parameters/alt" },
  3265. { $ref: "#/components/parameters/callback" },
  3266. { $ref: "#/components/parameters/fields" },
  3267. { $ref: "#/components/parameters/oauth_token" },
  3268. { $ref: "#/components/parameters/prettyPrint" },
  3269. { $ref: "#/components/parameters/quotaUser" },
  3270. { $ref: "#/components/parameters/uploadType" },
  3271. { $ref: "#/components/parameters/upload_protocol" },
  3272. ],
  3273. },
  3274. "/v2/projects/{targetProjectId}/tenants/{tenantId}/defaultSupportedIdpConfigs/{defaultSupportedIdpConfigsId}": {
  3275. delete: {
  3276. description: "Delete a default supported Idp configuration for an Identity Toolkit project.",
  3277. operationId: "identitytoolkit.projects.tenants.defaultSupportedIdpConfigs.delete",
  3278. responses: {
  3279. "200": {
  3280. description: "Successful response",
  3281. content: { "*/*": { schema: { $ref: "#/components/schemas/GoogleProtobufEmpty" } } },
  3282. },
  3283. },
  3284. parameters: [
  3285. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  3286. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  3287. {
  3288. name: "defaultSupportedIdpConfigsId",
  3289. in: "path",
  3290. required: true,
  3291. schema: { type: "string" },
  3292. },
  3293. ],
  3294. security: [
  3295. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  3296. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  3297. { apiKeyQuery: [] },
  3298. { apiKeyHeader: [] },
  3299. ],
  3300. tags: ["projects"],
  3301. },
  3302. get: {
  3303. description: "Retrieve a default supported Idp configuration for an Identity Toolkit project.",
  3304. operationId: "identitytoolkit.projects.tenants.defaultSupportedIdpConfigs.get",
  3305. responses: {
  3306. "200": {
  3307. description: "Successful response",
  3308. content: {
  3309. "*/*": {
  3310. schema: {
  3311. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig",
  3312. },
  3313. },
  3314. },
  3315. },
  3316. },
  3317. parameters: [
  3318. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  3319. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  3320. {
  3321. name: "defaultSupportedIdpConfigsId",
  3322. in: "path",
  3323. required: true,
  3324. schema: { type: "string" },
  3325. },
  3326. ],
  3327. security: [
  3328. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  3329. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  3330. { apiKeyQuery: [] },
  3331. { apiKeyHeader: [] },
  3332. ],
  3333. tags: ["projects"],
  3334. },
  3335. patch: {
  3336. description: "Update a default supported Idp configuration for an Identity Toolkit project.",
  3337. operationId: "identitytoolkit.projects.tenants.defaultSupportedIdpConfigs.patch",
  3338. responses: {
  3339. "200": {
  3340. description: "Successful response",
  3341. content: {
  3342. "*/*": {
  3343. schema: {
  3344. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig",
  3345. },
  3346. },
  3347. },
  3348. },
  3349. },
  3350. parameters: [
  3351. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  3352. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  3353. {
  3354. name: "defaultSupportedIdpConfigsId",
  3355. in: "path",
  3356. required: true,
  3357. schema: { type: "string" },
  3358. },
  3359. {
  3360. name: "updateMask",
  3361. in: "query",
  3362. description: "The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask",
  3363. schema: { type: "string" },
  3364. },
  3365. ],
  3366. requestBody: {
  3367. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig",
  3368. },
  3369. security: [
  3370. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  3371. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  3372. { apiKeyQuery: [] },
  3373. { apiKeyHeader: [] },
  3374. ],
  3375. tags: ["projects"],
  3376. },
  3377. parameters: [
  3378. { $ref: "#/components/parameters/access_token" },
  3379. { $ref: "#/components/parameters/alt" },
  3380. { $ref: "#/components/parameters/callback" },
  3381. { $ref: "#/components/parameters/fields" },
  3382. { $ref: "#/components/parameters/oauth_token" },
  3383. { $ref: "#/components/parameters/prettyPrint" },
  3384. { $ref: "#/components/parameters/quotaUser" },
  3385. { $ref: "#/components/parameters/uploadType" },
  3386. { $ref: "#/components/parameters/upload_protocol" },
  3387. ],
  3388. },
  3389. "/v2/projects/{targetProjectId}/tenants/{tenantId}/inboundSamlConfigs": {
  3390. post: {
  3391. description: "Create an inbound SAML configuration for an Identity Toolkit project.",
  3392. operationId: "identitytoolkit.projects.tenants.inboundSamlConfigs.create",
  3393. responses: {
  3394. "200": {
  3395. description: "Successful response",
  3396. content: {
  3397. "*/*": {
  3398. schema: {
  3399. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig",
  3400. },
  3401. },
  3402. },
  3403. },
  3404. },
  3405. parameters: [
  3406. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  3407. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  3408. {
  3409. name: "inboundSamlConfigId",
  3410. in: "query",
  3411. description: "The id to use for this config.",
  3412. schema: { type: "string" },
  3413. },
  3414. ],
  3415. requestBody: {
  3416. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig",
  3417. },
  3418. security: [
  3419. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  3420. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  3421. { apiKeyQuery: [] },
  3422. { apiKeyHeader: [] },
  3423. ],
  3424. tags: ["projects"],
  3425. },
  3426. get: {
  3427. description: "List all inbound SAML configurations for an Identity Toolkit project.",
  3428. operationId: "identitytoolkit.projects.tenants.inboundSamlConfigs.list",
  3429. responses: {
  3430. "200": {
  3431. description: "Successful response",
  3432. content: {
  3433. "*/*": {
  3434. schema: {
  3435. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2ListInboundSamlConfigsResponse",
  3436. },
  3437. },
  3438. },
  3439. },
  3440. },
  3441. parameters: [
  3442. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  3443. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  3444. {
  3445. name: "pageSize",
  3446. in: "query",
  3447. description: "The maximum number of items to return.",
  3448. schema: { type: "integer" },
  3449. },
  3450. {
  3451. name: "pageToken",
  3452. in: "query",
  3453. description: "The next_page_token value returned from a previous List request, if any.",
  3454. schema: { type: "string" },
  3455. },
  3456. ],
  3457. security: [
  3458. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  3459. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  3460. { apiKeyQuery: [] },
  3461. { apiKeyHeader: [] },
  3462. ],
  3463. tags: ["projects"],
  3464. },
  3465. parameters: [
  3466. { $ref: "#/components/parameters/access_token" },
  3467. { $ref: "#/components/parameters/alt" },
  3468. { $ref: "#/components/parameters/callback" },
  3469. { $ref: "#/components/parameters/fields" },
  3470. { $ref: "#/components/parameters/oauth_token" },
  3471. { $ref: "#/components/parameters/prettyPrint" },
  3472. { $ref: "#/components/parameters/quotaUser" },
  3473. { $ref: "#/components/parameters/uploadType" },
  3474. { $ref: "#/components/parameters/upload_protocol" },
  3475. ],
  3476. },
  3477. "/v2/projects/{targetProjectId}/tenants/{tenantId}/inboundSamlConfigs/{inboundSamlConfigsId}": {
  3478. delete: {
  3479. description: "Delete an inbound SAML configuration for an Identity Toolkit project.",
  3480. operationId: "identitytoolkit.projects.tenants.inboundSamlConfigs.delete",
  3481. responses: {
  3482. "200": {
  3483. description: "Successful response",
  3484. content: { "*/*": { schema: { $ref: "#/components/schemas/GoogleProtobufEmpty" } } },
  3485. },
  3486. },
  3487. parameters: [
  3488. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  3489. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  3490. { name: "inboundSamlConfigsId", in: "path", required: true, schema: { type: "string" } },
  3491. ],
  3492. security: [
  3493. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  3494. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  3495. { apiKeyQuery: [] },
  3496. { apiKeyHeader: [] },
  3497. ],
  3498. tags: ["projects"],
  3499. },
  3500. get: {
  3501. description: "Retrieve an inbound SAML configuration for an Identity Toolkit project.",
  3502. operationId: "identitytoolkit.projects.tenants.inboundSamlConfigs.get",
  3503. responses: {
  3504. "200": {
  3505. description: "Successful response",
  3506. content: {
  3507. "*/*": {
  3508. schema: {
  3509. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig",
  3510. },
  3511. },
  3512. },
  3513. },
  3514. },
  3515. parameters: [
  3516. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  3517. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  3518. { name: "inboundSamlConfigsId", in: "path", required: true, schema: { type: "string" } },
  3519. ],
  3520. security: [
  3521. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  3522. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  3523. { apiKeyQuery: [] },
  3524. { apiKeyHeader: [] },
  3525. ],
  3526. tags: ["projects"],
  3527. },
  3528. patch: {
  3529. description: "Update an inbound SAML configuration for an Identity Toolkit project.",
  3530. operationId: "identitytoolkit.projects.tenants.inboundSamlConfigs.patch",
  3531. responses: {
  3532. "200": {
  3533. description: "Successful response",
  3534. content: {
  3535. "*/*": {
  3536. schema: {
  3537. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig",
  3538. },
  3539. },
  3540. },
  3541. },
  3542. },
  3543. parameters: [
  3544. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  3545. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  3546. { name: "inboundSamlConfigsId", in: "path", required: true, schema: { type: "string" } },
  3547. {
  3548. name: "updateMask",
  3549. in: "query",
  3550. description: "The update mask applies to the resource. Empty update mask will result in updating nothing. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask",
  3551. schema: { type: "string" },
  3552. },
  3553. ],
  3554. requestBody: {
  3555. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig",
  3556. },
  3557. security: [
  3558. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  3559. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  3560. { apiKeyQuery: [] },
  3561. { apiKeyHeader: [] },
  3562. ],
  3563. tags: ["projects"],
  3564. },
  3565. parameters: [
  3566. { $ref: "#/components/parameters/access_token" },
  3567. { $ref: "#/components/parameters/alt" },
  3568. { $ref: "#/components/parameters/callback" },
  3569. { $ref: "#/components/parameters/fields" },
  3570. { $ref: "#/components/parameters/oauth_token" },
  3571. { $ref: "#/components/parameters/prettyPrint" },
  3572. { $ref: "#/components/parameters/quotaUser" },
  3573. { $ref: "#/components/parameters/uploadType" },
  3574. { $ref: "#/components/parameters/upload_protocol" },
  3575. ],
  3576. },
  3577. "/v2/projects/{targetProjectId}/tenants/{tenantId}/oauthIdpConfigs": {
  3578. post: {
  3579. description: "Create an Oidc Idp configuration for an Identity Toolkit project.",
  3580. operationId: "identitytoolkit.projects.tenants.oauthIdpConfigs.create",
  3581. responses: {
  3582. "200": {
  3583. description: "Successful response",
  3584. content: {
  3585. "*/*": {
  3586. schema: {
  3587. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig",
  3588. },
  3589. },
  3590. },
  3591. },
  3592. },
  3593. parameters: [
  3594. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  3595. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  3596. {
  3597. name: "oauthIdpConfigId",
  3598. in: "query",
  3599. description: "The id to use for this config.",
  3600. schema: { type: "string" },
  3601. },
  3602. ],
  3603. requestBody: {
  3604. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig",
  3605. },
  3606. security: [
  3607. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  3608. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  3609. { apiKeyQuery: [] },
  3610. { apiKeyHeader: [] },
  3611. ],
  3612. tags: ["projects"],
  3613. },
  3614. get: {
  3615. description: "List all Oidc Idp configurations for an Identity Toolkit project.",
  3616. operationId: "identitytoolkit.projects.tenants.oauthIdpConfigs.list",
  3617. responses: {
  3618. "200": {
  3619. description: "Successful response",
  3620. content: {
  3621. "*/*": {
  3622. schema: {
  3623. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2ListOAuthIdpConfigsResponse",
  3624. },
  3625. },
  3626. },
  3627. },
  3628. },
  3629. parameters: [
  3630. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  3631. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  3632. {
  3633. name: "pageSize",
  3634. in: "query",
  3635. description: "The maximum number of items to return.",
  3636. schema: { type: "integer" },
  3637. },
  3638. {
  3639. name: "pageToken",
  3640. in: "query",
  3641. description: "The next_page_token value returned from a previous List request, if any.",
  3642. schema: { type: "string" },
  3643. },
  3644. ],
  3645. security: [
  3646. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  3647. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  3648. { apiKeyQuery: [] },
  3649. { apiKeyHeader: [] },
  3650. ],
  3651. tags: ["projects"],
  3652. },
  3653. parameters: [
  3654. { $ref: "#/components/parameters/access_token" },
  3655. { $ref: "#/components/parameters/alt" },
  3656. { $ref: "#/components/parameters/callback" },
  3657. { $ref: "#/components/parameters/fields" },
  3658. { $ref: "#/components/parameters/oauth_token" },
  3659. { $ref: "#/components/parameters/prettyPrint" },
  3660. { $ref: "#/components/parameters/quotaUser" },
  3661. { $ref: "#/components/parameters/uploadType" },
  3662. { $ref: "#/components/parameters/upload_protocol" },
  3663. ],
  3664. },
  3665. "/v2/projects/{targetProjectId}/tenants/{tenantId}/oauthIdpConfigs/{oauthIdpConfigsId}": {
  3666. delete: {
  3667. description: "Delete an Oidc Idp configuration for an Identity Toolkit project.",
  3668. operationId: "identitytoolkit.projects.tenants.oauthIdpConfigs.delete",
  3669. responses: {
  3670. "200": {
  3671. description: "Successful response",
  3672. content: { "*/*": { schema: { $ref: "#/components/schemas/GoogleProtobufEmpty" } } },
  3673. },
  3674. },
  3675. parameters: [
  3676. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  3677. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  3678. { name: "oauthIdpConfigsId", in: "path", required: true, schema: { type: "string" } },
  3679. ],
  3680. security: [
  3681. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  3682. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  3683. { apiKeyQuery: [] },
  3684. { apiKeyHeader: [] },
  3685. ],
  3686. tags: ["projects"],
  3687. },
  3688. get: {
  3689. description: "Retrieve an Oidc Idp configuration for an Identity Toolkit project.",
  3690. operationId: "identitytoolkit.projects.tenants.oauthIdpConfigs.get",
  3691. responses: {
  3692. "200": {
  3693. description: "Successful response",
  3694. content: {
  3695. "*/*": {
  3696. schema: {
  3697. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig",
  3698. },
  3699. },
  3700. },
  3701. },
  3702. },
  3703. parameters: [
  3704. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  3705. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  3706. { name: "oauthIdpConfigsId", in: "path", required: true, schema: { type: "string" } },
  3707. ],
  3708. security: [
  3709. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  3710. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  3711. { apiKeyQuery: [] },
  3712. { apiKeyHeader: [] },
  3713. ],
  3714. tags: ["projects"],
  3715. },
  3716. patch: {
  3717. description: "Update an Oidc Idp configuration for an Identity Toolkit project.",
  3718. operationId: "identitytoolkit.projects.tenants.oauthIdpConfigs.patch",
  3719. responses: {
  3720. "200": {
  3721. description: "Successful response",
  3722. content: {
  3723. "*/*": {
  3724. schema: {
  3725. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig",
  3726. },
  3727. },
  3728. },
  3729. },
  3730. },
  3731. parameters: [
  3732. { name: "targetProjectId", in: "path", required: true, schema: { type: "string" } },
  3733. { name: "tenantId", in: "path", required: true, schema: { type: "string" } },
  3734. { name: "oauthIdpConfigsId", in: "path", required: true, schema: { type: "string" } },
  3735. {
  3736. name: "updateMask",
  3737. in: "query",
  3738. description: "The update mask applies to the resource. Empty update mask will result in updating nothing. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask",
  3739. schema: { type: "string" },
  3740. },
  3741. ],
  3742. requestBody: {
  3743. $ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig",
  3744. },
  3745. security: [
  3746. { Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
  3747. { Oauth2: ["https://www.googleapis.com/auth/firebase"] },
  3748. { apiKeyQuery: [] },
  3749. { apiKeyHeader: [] },
  3750. ],
  3751. tags: ["projects"],
  3752. },
  3753. parameters: [
  3754. { $ref: "#/components/parameters/access_token" },
  3755. { $ref: "#/components/parameters/alt" },
  3756. { $ref: "#/components/parameters/callback" },
  3757. { $ref: "#/components/parameters/fields" },
  3758. { $ref: "#/components/parameters/oauth_token" },
  3759. { $ref: "#/components/parameters/prettyPrint" },
  3760. { $ref: "#/components/parameters/quotaUser" },
  3761. { $ref: "#/components/parameters/uploadType" },
  3762. { $ref: "#/components/parameters/upload_protocol" },
  3763. ],
  3764. },
  3765. "/v1/token": {
  3766. post: {
  3767. description: "The Token Service API lets you exchange either an ID token or a refresh token for an access token and a new refresh token. You can use the access token to securely call APIs that require user authorization.",
  3768. operationId: "securetoken.token",
  3769. responses: {
  3770. "200": {
  3771. description: "Successful response",
  3772. content: { "*/*": { schema: { $ref: "#/components/schemas/GrantTokenResponse" } } },
  3773. },
  3774. },
  3775. requestBody: {
  3776. content: {
  3777. "application/json": { schema: { $ref: "#/components/schemas/GrantTokenRequest" } },
  3778. "application/x-www-form-urlencoded": {
  3779. schema: { $ref: "#/components/schemas/GrantTokenRequest" },
  3780. },
  3781. },
  3782. },
  3783. tags: ["secureToken"],
  3784. security: [{ apiKeyQuery: [] }, { apiKeyHeader: [] }],
  3785. },
  3786. parameters: [
  3787. { $ref: "#/components/parameters/access_token" },
  3788. { $ref: "#/components/parameters/alt" },
  3789. { $ref: "#/components/parameters/callback" },
  3790. { $ref: "#/components/parameters/fields" },
  3791. { $ref: "#/components/parameters/oauth_token" },
  3792. { $ref: "#/components/parameters/prettyPrint" },
  3793. { $ref: "#/components/parameters/quotaUser" },
  3794. { $ref: "#/components/parameters/uploadType" },
  3795. { $ref: "#/components/parameters/upload_protocol" },
  3796. ],
  3797. servers: [{ url: "https://securetoken.googleapis.com" }],
  3798. },
  3799. "/emulator/v1/projects/{targetProjectId}/accounts": {
  3800. parameters: [
  3801. {
  3802. name: "targetProjectId",
  3803. in: "path",
  3804. description: "The ID of the Google Cloud project that the accounts belong to.",
  3805. required: true,
  3806. schema: { type: "string" },
  3807. },
  3808. ],
  3809. servers: [{ url: "" }],
  3810. delete: {
  3811. description: "Remove all accounts in the project, regardless of state.",
  3812. operationId: "emulator.projects.accounts.delete",
  3813. responses: {
  3814. "200": {
  3815. description: "Successful response",
  3816. content: { "application/json": { schema: { type: "object" } } },
  3817. },
  3818. },
  3819. security: [],
  3820. tags: ["emulator"],
  3821. },
  3822. },
  3823. "/emulator/v1/projects/{targetProjectId}/tenants/{tenantId}/accounts": {
  3824. parameters: [
  3825. {
  3826. name: "targetProjectId",
  3827. in: "path",
  3828. description: "The ID of the Google Cloud project that the accounts belong to.",
  3829. required: true,
  3830. schema: { type: "string" },
  3831. },
  3832. {
  3833. name: "tenantId",
  3834. in: "path",
  3835. description: "The ID of the Identity Platform tenant the accounts belongs to. If not specified, accounts on the Identity Platform project are returned.",
  3836. required: true,
  3837. schema: { type: "string" },
  3838. },
  3839. ],
  3840. servers: [{ url: "" }],
  3841. delete: {
  3842. description: "Remove all accounts in the project, regardless of state.",
  3843. operationId: "emulator.projects.accounts.delete",
  3844. responses: {
  3845. "200": {
  3846. description: "Successful response",
  3847. content: { "application/json": { schema: { type: "object" } } },
  3848. },
  3849. },
  3850. security: [],
  3851. tags: ["emulator"],
  3852. },
  3853. },
  3854. "/emulator/v1/projects/{targetProjectId}/config": {
  3855. parameters: [
  3856. {
  3857. name: "targetProjectId",
  3858. in: "path",
  3859. description: "The ID of the Google Cloud project that the config belongs to.",
  3860. required: true,
  3861. schema: { type: "string" },
  3862. },
  3863. ],
  3864. servers: [{ url: "" }],
  3865. get: {
  3866. description: "Get emulator-specific configuration for the project.",
  3867. operationId: "emulator.projects.config.get",
  3868. responses: {
  3869. "200": {
  3870. description: "Successful response",
  3871. content: {
  3872. "application/json": {
  3873. schema: { $ref: "#/components/schemas/EmulatorV1ProjectsConfig" },
  3874. },
  3875. },
  3876. },
  3877. },
  3878. security: [],
  3879. tags: ["emulator"],
  3880. },
  3881. patch: {
  3882. description: "Update emulator-specific configuration for the project.",
  3883. operationId: "emulator.projects.config.update",
  3884. requestBody: {
  3885. content: {
  3886. "application/json": {
  3887. schema: { $ref: "#/components/schemas/EmulatorV1ProjectsConfig" },
  3888. },
  3889. },
  3890. },
  3891. responses: {
  3892. "200": {
  3893. description: "Successful response",
  3894. content: {
  3895. "application/json": {
  3896. schema: { $ref: "#/components/schemas/EmulatorV1ProjectsConfig" },
  3897. },
  3898. },
  3899. },
  3900. },
  3901. security: [],
  3902. tags: ["emulator"],
  3903. },
  3904. },
  3905. "/emulator/v1/projects/{targetProjectId}/oobCodes": {
  3906. parameters: [
  3907. {
  3908. name: "targetProjectId",
  3909. in: "path",
  3910. description: "The ID of the Google Cloud project that the confirmation codes belongs to.",
  3911. required: true,
  3912. schema: { type: "string" },
  3913. },
  3914. ],
  3915. servers: [{ url: "" }],
  3916. get: {
  3917. description: "List all pending confirmation codes for the project.",
  3918. operationId: "emulator.projects.oobCodes.list",
  3919. responses: {
  3920. "200": {
  3921. description: "Successful response",
  3922. content: {
  3923. "application/json": {
  3924. schema: { $ref: "#/components/schemas/EmulatorV1ProjectsOobCodes" },
  3925. },
  3926. },
  3927. },
  3928. },
  3929. security: [],
  3930. tags: ["emulator"],
  3931. },
  3932. },
  3933. "/emulator/v1/projects/{targetProjectId}/tenants/{tenantId}/oobCodes": {
  3934. parameters: [
  3935. {
  3936. name: "targetProjectId",
  3937. in: "path",
  3938. description: "The ID of the Google Cloud project that the confirmation codes belongs to.",
  3939. required: true,
  3940. schema: { type: "string" },
  3941. },
  3942. {
  3943. name: "tenantId",
  3944. in: "path",
  3945. description: "The ID of the Identity Platform tenant the accounts belongs to. If not specified, accounts on the Identity Platform project are returned.",
  3946. required: true,
  3947. schema: { type: "string" },
  3948. },
  3949. ],
  3950. servers: [{ url: "" }],
  3951. get: {
  3952. description: "List all pending confirmation codes for the project.",
  3953. operationId: "emulator.projects.oobCodes.list",
  3954. responses: {
  3955. "200": {
  3956. description: "Successful response",
  3957. content: {
  3958. "application/json": {
  3959. schema: { $ref: "#/components/schemas/EmulatorV1ProjectsOobCodes" },
  3960. },
  3961. },
  3962. },
  3963. },
  3964. security: [],
  3965. tags: ["emulator"],
  3966. },
  3967. },
  3968. "/emulator/v1/projects/{targetProjectId}/verificationCodes": {
  3969. parameters: [
  3970. {
  3971. name: "targetProjectId",
  3972. in: "path",
  3973. description: "The ID of the Google Cloud project that the verification codes belongs to.",
  3974. required: true,
  3975. schema: { type: "string" },
  3976. },
  3977. ],
  3978. servers: [{ url: "" }],
  3979. get: {
  3980. description: "List all pending phone verification codes for the project.",
  3981. operationId: "emulator.projects.verificationCodes.list",
  3982. responses: {
  3983. "200": {
  3984. description: "Successful response",
  3985. content: {
  3986. "application/json": {
  3987. schema: { $ref: "#/components/schemas/EmulatorV1ProjectsOobCodes" },
  3988. },
  3989. },
  3990. },
  3991. },
  3992. security: [],
  3993. tags: ["emulator"],
  3994. },
  3995. },
  3996. "/emulator/v1/projects/{targetProjectId}/tenants/{tenantId}/verificationCodes": {
  3997. parameters: [
  3998. {
  3999. name: "targetProjectId",
  4000. in: "path",
  4001. description: "The ID of the Google Cloud project that the verification codes belongs to.",
  4002. required: true,
  4003. schema: { type: "string" },
  4004. },
  4005. {
  4006. name: "tenantId",
  4007. in: "path",
  4008. description: "The ID of the Identity Platform tenant the accounts belongs to. If not specified, accounts on the Identity Platform project are returned.",
  4009. required: true,
  4010. schema: { type: "string" },
  4011. },
  4012. ],
  4013. servers: [{ url: "" }],
  4014. get: {
  4015. description: "List all pending phone verification codes for the project.",
  4016. operationId: "emulator.projects.verificationCodes.list",
  4017. responses: {
  4018. "200": {
  4019. description: "Successful response",
  4020. content: {
  4021. "application/json": {
  4022. schema: { $ref: "#/components/schemas/EmulatorV1ProjectsOobCodes" },
  4023. },
  4024. },
  4025. },
  4026. },
  4027. security: [],
  4028. tags: ["emulator"],
  4029. },
  4030. },
  4031. },
  4032. components: {
  4033. schemas: {
  4034. GoogleCloudIdentitytoolkitV1Argon2Parameters: {
  4035. description: "The parameters for Argon2 hashing algorithm.",
  4036. properties: {
  4037. associatedData: {
  4038. description: "The additional associated data, if provided, is appended to the hash value to provide an additional layer of security. A base64-encoded string if specified via JSON.",
  4039. format: "byte",
  4040. type: "string",
  4041. },
  4042. hashLengthBytes: {
  4043. description: "Required. The desired hash length in bytes. Minimum is 4 and maximum is 1024.",
  4044. format: "int32",
  4045. type: "integer",
  4046. },
  4047. hashType: {
  4048. description: "Required. Must not be HASH_TYPE_UNSPECIFIED.",
  4049. enum: ["HASH_TYPE_UNSPECIFIED", "ARGON2_D", "ARGON2_ID", "ARGON2_I"],
  4050. type: "string",
  4051. },
  4052. iterations: {
  4053. description: "Required. The number of iterations to perform. Minimum is 1, maximum is 16.",
  4054. format: "int32",
  4055. type: "integer",
  4056. },
  4057. memoryCostKib: {
  4058. description: "Required. The memory cost in kibibytes. Maximum is 32768.",
  4059. format: "int32",
  4060. type: "integer",
  4061. },
  4062. parallelism: {
  4063. description: "Required. The degree of parallelism, also called threads or lanes. Minimum is 1, maximum is 16.",
  4064. format: "int32",
  4065. type: "integer",
  4066. },
  4067. version: {
  4068. description: "The version of the Argon2 algorithm. This defaults to VERSION_13 if not specified.",
  4069. enum: ["VERSION_UNSPECIFIED", "VERSION_10", "VERSION_13"],
  4070. type: "string",
  4071. },
  4072. },
  4073. type: "object",
  4074. },
  4075. GoogleCloudIdentitytoolkitV1AutoRetrievalInfo: {
  4076. description: "The information required to auto-retrieve an SMS.",
  4077. properties: {
  4078. appSignatureHash: {
  4079. description: "The Android app's signature hash for Google Play Service's SMS Retriever API.",
  4080. type: "string",
  4081. },
  4082. },
  4083. type: "object",
  4084. },
  4085. GoogleCloudIdentitytoolkitV1BatchDeleteAccountsRequest: {
  4086. description: "Request message for BatchDeleteAccounts.",
  4087. properties: {
  4088. force: {
  4089. description: "Whether to force deleting accounts that are not in disabled state. If false, only disabled accounts will be deleted, and accounts that are not disabled will be added to the `errors`.",
  4090. type: "boolean",
  4091. },
  4092. localIds: {
  4093. description: "Required. List of user IDs to be deleted.",
  4094. items: { type: "string" },
  4095. type: "array",
  4096. },
  4097. tenantId: {
  4098. description: "If the accounts belong to an Identity Platform tenant, the ID of the tenant. If the accounts belong to an default Identity Platform project, the field is not needed.",
  4099. type: "string",
  4100. },
  4101. },
  4102. type: "object",
  4103. },
  4104. GoogleCloudIdentitytoolkitV1BatchDeleteAccountsResponse: {
  4105. description: "Response message to BatchDeleteAccounts.",
  4106. properties: {
  4107. errors: {
  4108. description: "Detailed error info for accounts that cannot be deleted.",
  4109. items: {
  4110. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1BatchDeleteErrorInfo",
  4111. },
  4112. type: "array",
  4113. },
  4114. },
  4115. type: "object",
  4116. },
  4117. GoogleCloudIdentitytoolkitV1BatchDeleteErrorInfo: {
  4118. description: "Error info for account failed to be deleted.",
  4119. properties: {
  4120. index: {
  4121. description: "The index of the errored item in the original local_ids field.",
  4122. format: "int32",
  4123. type: "integer",
  4124. },
  4125. localId: { description: "The corresponding user ID.", type: "string" },
  4126. message: { description: "Detailed error message.", type: "string" },
  4127. },
  4128. type: "object",
  4129. },
  4130. GoogleCloudIdentitytoolkitV1CreateAuthUriRequest: {
  4131. description: "Request message for CreateAuthUri.",
  4132. properties: {
  4133. appId: { type: "string" },
  4134. authFlowType: {
  4135. description: "Used for the Google provider. The type of the authentication flow to be used. If present, this should be `CODE_FLOW` to specify the authorization code flow. Otherwise, the default ID Token flow will be used.",
  4136. type: "string",
  4137. },
  4138. context: {
  4139. description: "An opaque string used to maintain contextual information between the authentication request and the callback from the IdP.",
  4140. type: "string",
  4141. },
  4142. continueUri: {
  4143. description: "A valid URL for the IdP to redirect the user back to. The URL cannot contain fragments or the reserved `state` query parameter.",
  4144. type: "string",
  4145. },
  4146. customParameter: {
  4147. additionalProperties: { type: "string" },
  4148. description: "Additional customized query parameters to be added to the authorization URI. The following parameters are reserved and cannot be added: `client_id`, `response_type`, `scope`, `redirect_uri`, `state`. For the Microsoft provider, the Azure AD tenant to sign-in to can be specified in the `tenant` custom parameter.",
  4149. type: "object",
  4150. },
  4151. hostedDomain: {
  4152. description: "Used for the Google provider. The G Suite hosted domain of the user in order to restrict sign-in to users at that domain.",
  4153. type: "string",
  4154. },
  4155. identifier: {
  4156. description: "The email identifier of the user account to fetch associated providers for. At least one of the fields `identifier` and `provider_id` must be set. The length of the email address should be less than 256 characters and in the format of `name@domain.tld`. The email address should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec production.",
  4157. type: "string",
  4158. },
  4159. oauthConsumerKey: { type: "string" },
  4160. oauthScope: {
  4161. description: "Additional space-delimited OAuth 2.0 scopes specifying the scope of the authentication request with the IdP. Used for OAuth 2.0 IdPs. For the Google provider, the authorization code flow will be used if this field is set.",
  4162. type: "string",
  4163. },
  4164. openidRealm: { type: "string" },
  4165. otaApp: { type: "string" },
  4166. providerId: {
  4167. description: "The provider ID of the IdP for the user to sign in with. This should be a provider ID enabled for sign-in, which is either from the list of [default supported IdPs](https://cloud.google.com/identity-platform/docs/reference/rest/v2/defaultSupportedIdps/list), or of the format `oidc.*` or `saml.*`. Some examples are `google.com`, `facebook.com`, `oidc.testapp`, and `saml.testapp`. At least one of the fields `identifier` and `provider_id` must be set.",
  4168. type: "string",
  4169. },
  4170. sessionId: {
  4171. description: "A session ID that can be verified against in SignInWithIdp to prevent session fixation attacks. If absent, a random string will be generated and returned as the session ID.",
  4172. type: "string",
  4173. },
  4174. tenantId: {
  4175. description: "The ID of the Identity Platform tenant to create an authorization URI or lookup an email identifier for. If not set, the operation will be performed in the default Identity Platform instance in the project.",
  4176. type: "string",
  4177. },
  4178. },
  4179. type: "object",
  4180. },
  4181. GoogleCloudIdentitytoolkitV1CreateAuthUriResponse: {
  4182. description: "Response message for CreateAuthUri.",
  4183. properties: {
  4184. allProviders: { items: { type: "string" }, type: "array" },
  4185. authUri: {
  4186. description: "The authorization URI for the requested provider. Present only when a provider ID is set in the request.",
  4187. type: "string",
  4188. },
  4189. captchaRequired: {
  4190. description: "Whether a CAPTCHA is needed because there have been too many failed login attempts by the user. Present only when a registered email identifier is set in the request.",
  4191. type: "boolean",
  4192. },
  4193. forExistingProvider: {
  4194. description: "Whether the user has previously signed in with the provider ID in the request. Present only when a registered email identifier is set in the request.",
  4195. type: "boolean",
  4196. },
  4197. kind: { type: "string" },
  4198. providerId: {
  4199. description: "The provider ID from the request, if provided.",
  4200. type: "string",
  4201. },
  4202. registered: {
  4203. description: "Whether the email identifier represents an existing account. Present only when an email identifier is set in the request.",
  4204. type: "boolean",
  4205. },
  4206. sessionId: {
  4207. description: "The session ID from the request, or a random string generated by CreateAuthUri if absent. It is used to prevent session fixation attacks.",
  4208. type: "string",
  4209. },
  4210. signinMethods: {
  4211. description: "The list of sign-in methods that the user has previously used. Each element is one of `password`, `emailLink`, or the provider ID of an IdP. Present only when a registered email identifier is set in the request.",
  4212. items: { type: "string" },
  4213. type: "array",
  4214. },
  4215. },
  4216. type: "object",
  4217. },
  4218. GoogleCloudIdentitytoolkitV1CreateSessionCookieRequest: {
  4219. description: "Request message for CreateSessionCookie.",
  4220. properties: {
  4221. idToken: { description: "Required. A valid Identity Platform ID token.", type: "string" },
  4222. tenantId: {
  4223. description: "The tenant ID of the Identity Platform tenant the account belongs to.",
  4224. type: "string",
  4225. },
  4226. validDuration: {
  4227. description: "The number of seconds until the session cookie expires. Specify a duration in seconds, between five minutes and fourteen days, inclusively.",
  4228. format: "int64",
  4229. type: "string",
  4230. },
  4231. },
  4232. type: "object",
  4233. },
  4234. GoogleCloudIdentitytoolkitV1CreateSessionCookieResponse: {
  4235. description: "Response message for CreateSessionCookie.",
  4236. properties: {
  4237. sessionCookie: {
  4238. description: "The session cookie that has been created from the Identity Platform ID token specified in the request. It is in the form of a JSON Web Token (JWT). Always present.",
  4239. type: "string",
  4240. },
  4241. },
  4242. type: "object",
  4243. },
  4244. GoogleCloudIdentitytoolkitV1DeleteAccountRequest: {
  4245. description: "Request message for DeleteAccount.",
  4246. properties: {
  4247. delegatedProjectNumber: { format: "int64", type: "string" },
  4248. idToken: {
  4249. description: "The Identity Platform ID token of the account to delete. Require to be specified for requests from end users that lack Google OAuth 2.0 credential. Authenticated requests bearing a Google OAuth2 credential with proper permissions may pass local_id to specify the account to delete alternatively.",
  4250. type: "string",
  4251. },
  4252. localId: {
  4253. description: "The ID of user account to delete. Specifying this field requires a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control). Requests from users lacking the credential should pass an ID token instead.",
  4254. type: "string",
  4255. },
  4256. targetProjectId: {
  4257. description: "The ID of the project which the account belongs to. Should only be specified in authenticated requests that specify local_id of an account.",
  4258. type: "string",
  4259. },
  4260. tenantId: {
  4261. description: "The ID of the tenant that the account belongs to, if applicable. Only require to be specified for authenticated requests bearing a Google OAuth 2.0 credential that specify local_id of an account that belongs to an Identity Platform tenant.",
  4262. type: "string",
  4263. },
  4264. },
  4265. type: "object",
  4266. },
  4267. GoogleCloudIdentitytoolkitV1DeleteAccountResponse: {
  4268. description: "Response message for DeleteAccount.",
  4269. properties: { kind: { type: "string" } },
  4270. type: "object",
  4271. },
  4272. GoogleCloudIdentitytoolkitV1DownloadAccountResponse: {
  4273. description: "Response message for DownloadAccount.",
  4274. properties: {
  4275. kind: { type: "string" },
  4276. nextPageToken: {
  4277. description: "If there are more accounts to be downloaded, a token that can be passed back to DownloadAccount to get more accounts. Otherwise, this is blank.",
  4278. type: "string",
  4279. },
  4280. users: {
  4281. description: "All accounts belonging to the project/tenant limited by max_results in the request.",
  4282. items: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1UserInfo" },
  4283. type: "array",
  4284. },
  4285. },
  4286. type: "object",
  4287. },
  4288. GoogleCloudIdentitytoolkitV1EmailTemplate: {
  4289. description: "Email template",
  4290. properties: {
  4291. body: { description: "Email body", type: "string" },
  4292. customized: {
  4293. description: "Whether the body or subject of the email is customized.",
  4294. type: "boolean",
  4295. },
  4296. disabled: {
  4297. description: "Whether the template is disabled. If true, a default template will be used.",
  4298. type: "boolean",
  4299. },
  4300. format: {
  4301. description: "Email body format",
  4302. enum: ["EMAIL_BODY_FORMAT_UNSPECIFIED", "PLAINTEXT", "HTML"],
  4303. type: "string",
  4304. },
  4305. from: { description: "From address of the email", type: "string" },
  4306. fromDisplayName: { description: "From display name", type: "string" },
  4307. fromLocalPart: { description: "Local part of From address", type: "string" },
  4308. locale: {
  4309. description: "Value is in III language code format (e.g. \"zh-CN\", \"es\"). Both '-' and '_' separators are accepted.",
  4310. type: "string",
  4311. },
  4312. replyTo: { description: "Reply-to address", type: "string" },
  4313. subject: { description: "Subject of the email", type: "string" },
  4314. },
  4315. type: "object",
  4316. },
  4317. GoogleCloudIdentitytoolkitV1ErrorInfo: {
  4318. description: "Error information explaining why an account cannot be uploaded. batch upload.",
  4319. properties: {
  4320. index: {
  4321. description: "The index of the item, range is [0, request.size - 1]",
  4322. format: "int32",
  4323. type: "integer",
  4324. },
  4325. message: { description: "Detailed error message", type: "string" },
  4326. },
  4327. type: "object",
  4328. },
  4329. GoogleCloudIdentitytoolkitV1FederatedUserIdentifier: {
  4330. description: "Federated user identifier at an Identity Provider.",
  4331. properties: {
  4332. providerId: {
  4333. description: "The ID of supported identity providers. This should be a provider ID enabled for sign-in, which is either from the list of [default supported IdPs](https://cloud.google.com/identity-platform/docs/reference/rest/v2/defaultSupportedIdps/list), or of the format `oidc.*` or `saml.*`. Some examples are `google.com`, `facebook.com`, `oidc.testapp`, and `saml.testapp`.",
  4334. type: "string",
  4335. },
  4336. rawId: {
  4337. description: "The user ID of the account at the third-party Identity Provider specified by `provider_id`.",
  4338. type: "string",
  4339. },
  4340. },
  4341. type: "object",
  4342. },
  4343. GoogleCloudIdentitytoolkitV1GetAccountInfoRequest: {
  4344. description: "Request message for GetAccountInfo.",
  4345. properties: {
  4346. delegatedProjectNumber: { format: "int64", type: "string" },
  4347. email: {
  4348. description: "The email address of one or more accounts to fetch. The length of email should be less than 256 characters and in the format of `name@domain.tld`. The email should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec production. Should only be specified by authenticated requests from a developer.",
  4349. items: { type: "string" },
  4350. type: "array",
  4351. },
  4352. federatedUserId: {
  4353. description: "The federated user identifier of one or more accounts to fetch. Should only be specified by authenticated requests bearing a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).",
  4354. items: {
  4355. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1FederatedUserIdentifier",
  4356. },
  4357. type: "array",
  4358. },
  4359. idToken: {
  4360. description: "The Identity Platform ID token of the account to fetch. Require to be specified for requests from end users.",
  4361. type: "string",
  4362. },
  4363. initialEmail: {
  4364. description: "The initial email of one or more accounts to fetch. The length of email should be less than 256 characters and in the format of `name@domain.tld`. The email should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec production. Should only be specified by authenticated requests from a developer.",
  4365. items: { type: "string" },
  4366. type: "array",
  4367. },
  4368. localId: {
  4369. description: "The ID of one or more accounts to fetch. Should only be specified by authenticated requests bearing a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).",
  4370. items: { type: "string" },
  4371. type: "array",
  4372. },
  4373. phoneNumber: {
  4374. description: "The phone number of one or more accounts to fetch. Should only be specified by authenticated requests from a developer and should be in E.164 format, for example, +15555555555.",
  4375. items: { type: "string" },
  4376. type: "array",
  4377. },
  4378. targetProjectId: {
  4379. description: "The ID of the Google Cloud project that the account or the Identity Platform tenant specified by `tenant_id` belongs to. Should only be specified by authenticated requests bearing a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).",
  4380. type: "string",
  4381. },
  4382. tenantId: {
  4383. description: "The ID of the tenant that the account belongs to. Should only be specified by authenticated requests from a developer.",
  4384. type: "string",
  4385. },
  4386. },
  4387. type: "object",
  4388. },
  4389. GoogleCloudIdentitytoolkitV1GetAccountInfoResponse: {
  4390. description: "Response message for GetAccountInfo.",
  4391. properties: {
  4392. kind: { type: "string" },
  4393. users: {
  4394. description: "The information of specific user account(s) matching the parameters in the request.",
  4395. items: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1UserInfo" },
  4396. type: "array",
  4397. },
  4398. },
  4399. type: "object",
  4400. },
  4401. GoogleCloudIdentitytoolkitV1GetOobCodeRequest: {
  4402. description: "Request message for GetOobCode.",
  4403. properties: {
  4404. androidInstallApp: {
  4405. description: "If an associated android app can handle the OOB code, whether or not to install the android app on the device where the link is opened if the app is not already installed.",
  4406. type: "boolean",
  4407. },
  4408. androidMinimumVersion: {
  4409. description: "If an associated android app can handle the OOB code, the minimum version of the app. If the version on the device is lower than this version then the user is taken to Google Play Store to upgrade the app.",
  4410. type: "string",
  4411. },
  4412. androidPackageName: {
  4413. description: "If an associated android app can handle the OOB code, the Android package name of the android app that will handle the callback when this OOB code is used. This will allow the correct app to open if it is already installed, or allow Google Play Store to open to the correct app if it is not yet installed.",
  4414. type: "string",
  4415. },
  4416. canHandleCodeInApp: {
  4417. description: "When set to true, the OOB code link will be be sent as a Universal Link or an Android App Link and will be opened by the corresponding app if installed. If not set, or set to false, the OOB code will be sent to the web widget first and then on continue will redirect to the app if installed.",
  4418. type: "boolean",
  4419. },
  4420. captchaResp: {
  4421. description: "For a PASSWORD_RESET request, a reCaptcha response is required when the system detects possible abuse activity. In those cases, this is the response from the reCaptcha challenge used to verify the caller.",
  4422. type: "string",
  4423. },
  4424. challenge: { type: "string" },
  4425. continueUrl: {
  4426. description: "The Url to continue after user clicks the link sent in email. This is the url that will allow the web widget to handle the OOB code.",
  4427. type: "string",
  4428. },
  4429. dynamicLinkDomain: {
  4430. description: "In order to ensure that the url used can be easily opened up in iOS or android, we create a [Firebase Dynamic Link](https://firebase.google.com/docs/dynamic-links). Most Identity Platform projects will only have one Dynamic Link domain enabled, and can leave this field blank. This field contains a specified Dynamic Link domain for projects that have multiple enabled.",
  4431. type: "string",
  4432. },
  4433. email: {
  4434. description: "The account's email address to send the OOB code to, and generally the email address of the account that needs to be updated. Required for PASSWORD_RESET, EMAIL_SIGNIN, and VERIFY_EMAIL. Only required for VERIFY_AND_CHANGE_EMAIL requests when return_oob_link is set to true. In this case, it is the original email of the user.",
  4435. type: "string",
  4436. },
  4437. iOSAppStoreId: {
  4438. description: "If an associated iOS app can handle the OOB code, the App Store id of this app. This will allow App Store to open to the correct app if the app is not yet installed.",
  4439. type: "string",
  4440. },
  4441. iOSBundleId: {
  4442. description: "If an associated iOS app can handle the OOB code, the iOS bundle id of this app. This will allow the correct app to open if it is already installed.",
  4443. type: "string",
  4444. },
  4445. idToken: {
  4446. description: "An ID token for the account. It is required for VERIFY_AND_CHANGE_EMAIL and VERIFY_EMAIL requests unless return_oob_link is set to true.",
  4447. type: "string",
  4448. },
  4449. newEmail: {
  4450. description: "The email address the account is being updated to. Required only for VERIFY_AND_CHANGE_EMAIL requests.",
  4451. type: "string",
  4452. },
  4453. requestType: {
  4454. description: "Required. The type of out-of-band (OOB) code to send. Depending on this value, other fields in this request will be required and/or have different meanings. There are 4 different OOB codes that can be sent: * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL",
  4455. enum: [
  4456. "OOB_REQ_TYPE_UNSPECIFIED",
  4457. "PASSWORD_RESET",
  4458. "OLD_EMAIL_AGREE",
  4459. "NEW_EMAIL_ACCEPT",
  4460. "VERIFY_EMAIL",
  4461. "RECOVER_EMAIL",
  4462. "EMAIL_SIGNIN",
  4463. "VERIFY_AND_CHANGE_EMAIL",
  4464. "REVERT_SECOND_FACTOR_ADDITION",
  4465. ],
  4466. type: "string",
  4467. },
  4468. returnOobLink: {
  4469. description: "Whether the confirmation link containing the OOB code should be returned in the response (no email is sent). Used when a developer wants to construct the email template and send it on their own. By default this is false; to specify this field, and to set it to true, it requires a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control)",
  4470. type: "boolean",
  4471. },
  4472. targetProjectId: {
  4473. description: "The Project ID of the Identity Platform project which the account belongs to. To specify this field, it requires a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).",
  4474. type: "string",
  4475. },
  4476. tenantId: {
  4477. description: "The tenant ID of the Identity Platform tenant the account belongs to.",
  4478. type: "string",
  4479. },
  4480. userIp: {
  4481. description: "The IP address of the caller. Required only for PASSWORD_RESET requests.",
  4482. type: "string",
  4483. },
  4484. },
  4485. type: "object",
  4486. },
  4487. GoogleCloudIdentitytoolkitV1GetOobCodeResponse: {
  4488. description: "Response message for GetOobCode.",
  4489. properties: {
  4490. email: {
  4491. description: "If return_oob_link is false in the request, the email address the verification was sent to.",
  4492. type: "string",
  4493. },
  4494. kind: { type: "string" },
  4495. oobCode: {
  4496. description: "If return_oob_link is true in the request, the OOB code to send.",
  4497. type: "string",
  4498. },
  4499. oobLink: {
  4500. description: "If return_oob_link is true in the request, the OOB link to be sent to the user. This returns the constructed link including [Firebase Dynamic Link](https://firebase.google.com/docs/dynamic-links) related parameters.",
  4501. type: "string",
  4502. },
  4503. },
  4504. type: "object",
  4505. },
  4506. GoogleCloudIdentitytoolkitV1GetProjectConfigResponse: {
  4507. description: "Response message for GetProjectConfig.",
  4508. properties: {
  4509. allowPasswordUser: {
  4510. description: "Whether to allow password account sign up. This field is only returned for authenticated calls from a developer.",
  4511. type: "boolean",
  4512. },
  4513. apiKey: {
  4514. description: "Google Cloud API key. This field is only returned for authenticated calls from a developer.",
  4515. type: "string",
  4516. },
  4517. authorizedDomains: {
  4518. description: "Authorized domains for widget redirect.",
  4519. items: { type: "string" },
  4520. type: "array",
  4521. },
  4522. changeEmailTemplate: {
  4523. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1EmailTemplate",
  4524. },
  4525. dynamicLinksDomain: {
  4526. description: "The Firebase Dynamic Links domain used to construct links for redirects to native apps.",
  4527. type: "string",
  4528. },
  4529. enableAnonymousUser: {
  4530. description: "Whether anonymous user is enabled. This field is only returned for authenticated calls from a developer.",
  4531. type: "boolean",
  4532. },
  4533. idpConfig: {
  4534. description: "OAuth2 provider config. This field is only returned for authenticated calls from a developer.",
  4535. items: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1IdpConfig" },
  4536. type: "array",
  4537. },
  4538. legacyResetPasswordTemplate: {
  4539. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1EmailTemplate",
  4540. },
  4541. projectId: {
  4542. description: "The project id of the retrieved configuration.",
  4543. type: "string",
  4544. },
  4545. resetPasswordTemplate: {
  4546. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1EmailTemplate",
  4547. },
  4548. revertSecondFactorAdditionTemplate: {
  4549. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1EmailTemplate",
  4550. },
  4551. useEmailSending: {
  4552. description: "Whether to use email sending. This field is only returned for authenticated calls from a developer.",
  4553. type: "boolean",
  4554. },
  4555. verifyEmailTemplate: {
  4556. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1EmailTemplate",
  4557. },
  4558. },
  4559. type: "object",
  4560. },
  4561. GoogleCloudIdentitytoolkitV1GetRecaptchaParamResponse: {
  4562. description: "Response message for GetRecaptchaParam.",
  4563. properties: {
  4564. kind: { type: "string" },
  4565. recaptchaSiteKey: {
  4566. description: "The reCAPTCHA v2 site key used to invoke the reCAPTCHA service. Always present.",
  4567. type: "string",
  4568. },
  4569. recaptchaStoken: { type: "string" },
  4570. },
  4571. type: "object",
  4572. },
  4573. GoogleCloudIdentitytoolkitV1GetSessionCookiePublicKeysResponse: {
  4574. description: "Response message for GetSessionCookiePublicKeys.",
  4575. properties: {
  4576. keys: {
  4577. description: "Public keys of the session cookie signer, formatted as [JSON Web Keys (JWK)](https://tools.ietf.org/html/rfc7517).",
  4578. items: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1OpenIdConnectKey" },
  4579. type: "array",
  4580. },
  4581. },
  4582. type: "object",
  4583. },
  4584. GoogleCloudIdentitytoolkitV1IdpConfig: {
  4585. description: "Config of an identity provider.",
  4586. properties: {
  4587. clientId: { description: "OAuth2 client ID.", type: "string" },
  4588. enabled: {
  4589. description: "True if allows the user to sign in with the provider.",
  4590. type: "boolean",
  4591. },
  4592. experimentPercent: {
  4593. description: "Percent of users who will be prompted/redirected federated login for this IdP",
  4594. format: "int32",
  4595. type: "integer",
  4596. },
  4597. provider: {
  4598. description: "Name of the identity provider.",
  4599. enum: [
  4600. "PROVIDER_UNSPECIFIED",
  4601. "MSLIVE",
  4602. "GOOGLE",
  4603. "FACEBOOK",
  4604. "PAYPAL",
  4605. "TWITTER",
  4606. "YAHOO",
  4607. "AOL",
  4608. "GITHUB",
  4609. "GOOGLE_PLAY_GAMES",
  4610. "LINKEDIN",
  4611. "IOS_GAME_CENTER",
  4612. ],
  4613. type: "string",
  4614. },
  4615. secret: { description: "OAuth2 client secret.", type: "string" },
  4616. whitelistedAudiences: {
  4617. description: "Whitelisted client IDs for audience check.",
  4618. items: { type: "string" },
  4619. type: "array",
  4620. },
  4621. },
  4622. type: "object",
  4623. },
  4624. GoogleCloudIdentitytoolkitV1IssueSamlResponseRequest: {
  4625. description: "Request message for IssueSamlResponse.",
  4626. properties: {
  4627. idToken: {
  4628. description: "The Identity Platform ID token. It will be verified and then converted to a new SAMLResponse.",
  4629. type: "string",
  4630. },
  4631. rpId: {
  4632. description: "Relying Party identifier, which is the audience of issued SAMLResponse.",
  4633. type: "string",
  4634. },
  4635. samlAppEntityId: {
  4636. description: "SAML app entity id specified in Google Admin Console for each app. If developers want to redirect to a third-party app rather than a G Suite app, they'll probably they need this. When it's used, we'll return a RelayState. This includes a SAMLRequest, which can be used to trigger a SP-initiated SAML flow to redirect to the real app.",
  4637. type: "string",
  4638. },
  4639. },
  4640. type: "object",
  4641. },
  4642. GoogleCloudIdentitytoolkitV1IssueSamlResponseResponse: {
  4643. description: "Response for IssueSamlResponse request.",
  4644. properties: {
  4645. acsEndpoint: {
  4646. description: "The ACS endpoint which consumes the returned SAMLResponse.",
  4647. type: "string",
  4648. },
  4649. email: { description: "Email of the user.", type: "string" },
  4650. firstName: { description: "First name of the user.", type: "string" },
  4651. isNewUser: {
  4652. description: "Whether the logged in user was created by this request.",
  4653. type: "boolean",
  4654. },
  4655. lastName: { description: "Last name of the user.", type: "string" },
  4656. relayState: { description: "Generated RelayState.", type: "string" },
  4657. samlResponse: {
  4658. description: "Signed SAMLResponse created for the Relying Party.",
  4659. type: "string",
  4660. },
  4661. },
  4662. type: "object",
  4663. },
  4664. GoogleCloudIdentitytoolkitV1MfaEnrollment: {
  4665. description: "Information on which multi-factor authentication (MFA) providers are enabled for an account.",
  4666. properties: {
  4667. displayName: {
  4668. description: 'Display name for this mfa option e.g. "corp cell phone".',
  4669. type: "string",
  4670. },
  4671. enrolledAt: {
  4672. description: "Timestamp when the account enrolled this second factor.",
  4673. format: "google-datetime",
  4674. type: "string",
  4675. },
  4676. mfaEnrollmentId: { description: "ID of this MFA option.", type: "string" },
  4677. phoneInfo: {
  4678. description: "Normally this will show the phone number associated with this enrollment. In some situations, such as after a first factor sign in, it will only show the obfuscated version of the associated phone number.",
  4679. type: "string",
  4680. },
  4681. unobfuscatedPhoneInfo: {
  4682. description: "Output only. Unobfuscated phone_info.",
  4683. readOnly: true,
  4684. type: "string",
  4685. },
  4686. },
  4687. type: "object",
  4688. },
  4689. GoogleCloudIdentitytoolkitV1MfaFactor: {
  4690. properties: {
  4691. displayName: {
  4692. description: 'Display name for this mfa option e.g. "corp cell phone".',
  4693. type: "string",
  4694. },
  4695. phoneInfo: { description: "Phone number to receive OTP for MFA.", type: "string" },
  4696. },
  4697. type: "object",
  4698. },
  4699. GoogleCloudIdentitytoolkitV1MfaInfo: {
  4700. description: "Multi-factor authentication related information.",
  4701. properties: {
  4702. enrollments: {
  4703. description: "The second factors the user has enrolled.",
  4704. items: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1MfaEnrollment" },
  4705. type: "array",
  4706. },
  4707. },
  4708. type: "object",
  4709. },
  4710. GoogleCloudIdentitytoolkitV1OpenIdConnectKey: {
  4711. description: "Represents a public key of the session cookie signer, formatted as a [JSON Web Key (JWK)](https://tools.ietf.org/html/rfc7517).",
  4712. properties: {
  4713. alg: { description: "Signature algorithm.", type: "string" },
  4714. e: {
  4715. description: "Exponent for the RSA public key, it is represented as the base64url encoding of the value's big endian representation.",
  4716. type: "string",
  4717. },
  4718. kid: { description: "Unique string to identify this key.", type: "string" },
  4719. kty: { description: "Key type.", type: "string" },
  4720. n: {
  4721. description: "Modulus for the RSA public key, it is represented as the base64url encoding of the value's big endian representation.",
  4722. type: "string",
  4723. },
  4724. use: { description: "Key use.", type: "string" },
  4725. },
  4726. type: "object",
  4727. },
  4728. GoogleCloudIdentitytoolkitV1ProviderUserInfo: {
  4729. description: "Information about the user as provided by various Identity Providers.",
  4730. properties: {
  4731. displayName: {
  4732. description: "The user's display name at the Identity Provider.",
  4733. type: "string",
  4734. },
  4735. email: {
  4736. description: "The user's email address at the Identity Provider.",
  4737. type: "string",
  4738. },
  4739. federatedId: {
  4740. description: "The user's identifier at the Identity Provider.",
  4741. type: "string",
  4742. },
  4743. phoneNumber: {
  4744. description: "The user's phone number at the Identity Provider.",
  4745. type: "string",
  4746. },
  4747. photoUrl: {
  4748. description: "The user's profile photo URL at the Identity Provider.",
  4749. type: "string",
  4750. },
  4751. providerId: { description: "The ID of the Identity Provider.", type: "string" },
  4752. rawId: {
  4753. description: "The user's raw identifier directly returned from Identity Provider.",
  4754. type: "string",
  4755. },
  4756. screenName: {
  4757. description: "The user's screen_name at Twitter or login name at GitHub.",
  4758. type: "string",
  4759. },
  4760. },
  4761. type: "object",
  4762. },
  4763. GoogleCloudIdentitytoolkitV1QueryUserInfoRequest: {
  4764. description: "Request message for QueryUserInfo.",
  4765. properties: {
  4766. expression: {
  4767. description: "Query conditions used to filter results. If more than one is passed, only the first SqlExpression is evaluated.",
  4768. items: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SqlExpression" },
  4769. type: "array",
  4770. },
  4771. limit: {
  4772. description: "The maximum number of accounts to return with an upper limit of __500__. Defaults to _500_. Only valid when `return_user_info` is set to `true`.",
  4773. format: "int64",
  4774. type: "string",
  4775. },
  4776. offset: {
  4777. description: "The number of accounts to skip from the beginning of matching records. Only valid when `return_user_info` is set to `true`.",
  4778. format: "int64",
  4779. type: "string",
  4780. },
  4781. order: {
  4782. description: "The order for sorting query result. Defaults to __ascending__ order. Only valid when `return_user_info` is set to `true`.",
  4783. enum: ["ORDER_UNSPECIFIED", "ASC", "DESC"],
  4784. type: "string",
  4785. },
  4786. returnUserInfo: {
  4787. description: "If `true`, this request will return the accounts matching the query. If `false`, only the __count__ of accounts matching the query will be returned. Defaults to `true`.",
  4788. type: "boolean",
  4789. },
  4790. sortBy: {
  4791. description: "The field to use for sorting user accounts. Defaults to `USER_ID`. Note: when `phone_number` is specified in `expression`, the result ignores the sorting. Only valid when `return_user_info` is set to `true`.",
  4792. enum: [
  4793. "SORT_BY_FIELD_UNSPECIFIED",
  4794. "USER_ID",
  4795. "NAME",
  4796. "CREATED_AT",
  4797. "LAST_LOGIN_AT",
  4798. "USER_EMAIL",
  4799. ],
  4800. type: "string",
  4801. },
  4802. tenantId: {
  4803. description: "The ID of the tenant to which the result is scoped.",
  4804. type: "string",
  4805. },
  4806. },
  4807. type: "object",
  4808. },
  4809. GoogleCloudIdentitytoolkitV1QueryUserInfoResponse: {
  4810. description: "Response message for QueryUserInfo.",
  4811. properties: {
  4812. recordsCount: {
  4813. description: "If `return_user_info` in the request is true, this is the number of returned accounts in this message. Otherwise, this is the total number of accounts matching the query.",
  4814. format: "int64",
  4815. type: "string",
  4816. },
  4817. userInfo: {
  4818. description: "If `return_user_info` in the request is true, this is the accounts matching the query.",
  4819. items: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1UserInfo" },
  4820. type: "array",
  4821. },
  4822. },
  4823. type: "object",
  4824. },
  4825. GoogleCloudIdentitytoolkitV1ResetPasswordRequest: {
  4826. description: "Request message for ResetPassword.",
  4827. properties: {
  4828. email: {
  4829. description: "The email of the account to be modified. Specify this and the old password in order to change an account's password without using an out-of-band code.",
  4830. type: "string",
  4831. },
  4832. newPassword: {
  4833. description: "The new password to be set for this account. Specifying this field will result in a change to the account and consume the out-of-band code if one was specified and it was of type PASSWORD_RESET.",
  4834. type: "string",
  4835. },
  4836. oldPassword: {
  4837. description: "The current password of the account to be modified. Specify this and email to change an account's password without using an out-of-band code.",
  4838. type: "string",
  4839. },
  4840. oobCode: {
  4841. description: "An out-of-band (OOB) code generated by GetOobCode request. Specify only this parameter (or only this parameter and a tenant ID) to get the out-of-band code's type in the response without mutating the account's state. Only a PASSWORD_RESET out-of-band code can be consumed via this method.",
  4842. type: "string",
  4843. },
  4844. tenantId: {
  4845. description: "The tenant ID of the Identity Platform tenant the account belongs to.",
  4846. type: "string",
  4847. },
  4848. },
  4849. type: "object",
  4850. },
  4851. GoogleCloudIdentitytoolkitV1ResetPasswordResponse: {
  4852. description: "Response message for ResetPassword.",
  4853. properties: {
  4854. email: {
  4855. description: "The email associated with the out-of-band code that was used.",
  4856. type: "string",
  4857. },
  4858. kind: { type: "string" },
  4859. mfaInfo: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1MfaEnrollment" },
  4860. newEmail: { type: "string" },
  4861. requestType: {
  4862. enum: [
  4863. "OOB_REQ_TYPE_UNSPECIFIED",
  4864. "PASSWORD_RESET",
  4865. "OLD_EMAIL_AGREE",
  4866. "NEW_EMAIL_ACCEPT",
  4867. "VERIFY_EMAIL",
  4868. "RECOVER_EMAIL",
  4869. "EMAIL_SIGNIN",
  4870. "VERIFY_AND_CHANGE_EMAIL",
  4871. "REVERT_SECOND_FACTOR_ADDITION",
  4872. ],
  4873. type: "string",
  4874. },
  4875. },
  4876. type: "object",
  4877. },
  4878. GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest: {
  4879. description: "Request message for SendVerificationCode. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator.",
  4880. properties: {
  4881. autoRetrievalInfo: {
  4882. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1AutoRetrievalInfo",
  4883. },
  4884. iosReceipt: {
  4885. description: "Receipt of successful iOS app token validation. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator. This should come from the response of verifyIosClient. If present, the caller should also provide the `ios_secret`, as well as a bundle ID in the `x-ios-bundle-identifier` header, which must match the bundle ID from the verifyIosClient request.",
  4886. type: "string",
  4887. },
  4888. iosSecret: {
  4889. description: "Secret delivered to iOS app as a push notification. Should be passed with an `ios_receipt` as well as the `x-ios-bundle-identifier` header.",
  4890. type: "string",
  4891. },
  4892. phoneNumber: {
  4893. description: "The phone number to send the verification code to in E.164 format.",
  4894. type: "string",
  4895. },
  4896. recaptchaToken: {
  4897. description: "Recaptcha token for app verification. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator. The recaptcha should be generated by calling getRecaptchaParams and the recaptcha token will be generated on user completion of the recaptcha challenge.",
  4898. type: "string",
  4899. },
  4900. safetyNetToken: {
  4901. description: "Android only. Used to assert application identity in place of a recaptcha token. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator. A SafetyNet Token can be generated via the [SafetyNet Android Attestation API](https://developer.android.com/training/safetynet/attestation.html), with the Base64 encoding of the `phone_number` field as the nonce.",
  4902. type: "string",
  4903. },
  4904. tenantId: {
  4905. description: "Tenant ID of the Identity Platform tenant the user is signing in to.",
  4906. type: "string",
  4907. },
  4908. },
  4909. type: "object",
  4910. },
  4911. GoogleCloudIdentitytoolkitV1SendVerificationCodeResponse: {
  4912. description: "Response message for SendVerificationCode.",
  4913. properties: {
  4914. sessionInfo: {
  4915. description: "Encrypted session information. This can be used in signInWithPhoneNumber to authenticate the phone number.",
  4916. type: "string",
  4917. },
  4918. },
  4919. type: "object",
  4920. },
  4921. GoogleCloudIdentitytoolkitV1SetAccountInfoRequest: {
  4922. description: "Request message for SetAccountInfo.",
  4923. properties: {
  4924. captchaChallenge: { type: "string" },
  4925. captchaResponse: {
  4926. description: "The response from reCaptcha challenge. This is required when the system detects possible abuse activities.",
  4927. type: "string",
  4928. },
  4929. createdAt: {
  4930. description: "The timestamp in milliseconds when the account was created.",
  4931. format: "int64",
  4932. type: "string",
  4933. },
  4934. customAttributes: {
  4935. description: "JSON formatted custom attributes to be stored in the Identity Platform ID token. Specifying this field requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control).",
  4936. type: "string",
  4937. },
  4938. delegatedProjectNumber: { format: "int64", type: "string" },
  4939. deleteAttribute: {
  4940. description: "The account's attributes to be deleted.",
  4941. items: {
  4942. enum: [
  4943. "USER_ATTRIBUTE_NAME_UNSPECIFIED",
  4944. "EMAIL",
  4945. "DISPLAY_NAME",
  4946. "PROVIDER",
  4947. "PHOTO_URL",
  4948. "PASSWORD",
  4949. "RAW_USER_INFO",
  4950. ],
  4951. type: "string",
  4952. },
  4953. type: "array",
  4954. },
  4955. deleteProvider: {
  4956. description: "The Identity Providers to unlink from the user's account.",
  4957. items: { type: "string" },
  4958. type: "array",
  4959. },
  4960. disableUser: {
  4961. description: "If true, marks the account as disabled, meaning the user will no longer be able to sign-in.",
  4962. type: "boolean",
  4963. },
  4964. displayName: {
  4965. description: "The user's new display name to be updated in the account's attributes. The length of the display name must be less than or equal to 256 characters.",
  4966. type: "string",
  4967. },
  4968. email: {
  4969. description: "The user's new email to be updated in the account's attributes. The length of email should be less than 256 characters and in the format of `name@domain.tld`. The email should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec production.",
  4970. type: "string",
  4971. },
  4972. emailVerified: {
  4973. description: "Whether the user's email has been verified. Specifying this field requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control).",
  4974. type: "boolean",
  4975. },
  4976. idToken: {
  4977. description: "A valid Identity Platform ID token. Required when attempting to change user-related information.",
  4978. type: "string",
  4979. },
  4980. instanceId: { type: "string" },
  4981. lastLoginAt: {
  4982. description: "The timestamp in milliseconds when the account last logged in.",
  4983. format: "int64",
  4984. type: "string",
  4985. },
  4986. linkProviderUserInfo: {
  4987. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1ProviderUserInfo",
  4988. },
  4989. localId: {
  4990. description: "The ID of the user. Specifying this field requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control). For requests from end-users, an ID token should be passed instead.",
  4991. type: "string",
  4992. },
  4993. mfa: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1MfaInfo" },
  4994. oobCode: {
  4995. description: "The out-of-band code to be applied on the user's account. The following out-of-band code types are supported: * VERIFY_EMAIL * RECOVER_EMAIL * REVERT_SECOND_FACTOR_ADDITION * VERIFY_AND_CHANGE_EMAIL",
  4996. type: "string",
  4997. },
  4998. password: {
  4999. description: "The user's new password to be updated in the account's attributes. The password must be at least 6 characters long.",
  5000. type: "string",
  5001. },
  5002. phoneNumber: {
  5003. description: "The phone number to be updated in the account's attributes.",
  5004. type: "string",
  5005. },
  5006. photoUrl: {
  5007. description: "The user's new photo URL for the account's profile photo to be updated in the account's attributes. The length of the URL must be less than or equal to 2048 characters.",
  5008. type: "string",
  5009. },
  5010. provider: {
  5011. description: "The Identity Providers that the account should be associated with.",
  5012. items: { type: "string" },
  5013. type: "array",
  5014. },
  5015. returnSecureToken: {
  5016. description: "Whether or not to return an ID and refresh token. Should always be true.",
  5017. type: "boolean",
  5018. },
  5019. targetProjectId: {
  5020. description: "The project ID for the project that the account belongs to. Specifying this field requires Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control). Requests from end users should pass an Identity Platform ID token instead.",
  5021. type: "string",
  5022. },
  5023. tenantId: {
  5024. description: "The tenant ID of the Identity Platform tenant that the account belongs to. Requests from end users should pass an Identity Platform ID token rather than setting this field.",
  5025. type: "string",
  5026. },
  5027. upgradeToFederatedLogin: {
  5028. description: "Whether the account should be restricted to only using federated login.",
  5029. type: "boolean",
  5030. },
  5031. validSince: {
  5032. description: "Specifies the minimum timestamp in seconds for an Identity Platform ID token to be considered valid.",
  5033. format: "int64",
  5034. type: "string",
  5035. },
  5036. },
  5037. type: "object",
  5038. },
  5039. GoogleCloudIdentitytoolkitV1SetAccountInfoResponse: {
  5040. description: "Response message for SetAccountInfo",
  5041. properties: {
  5042. displayName: { description: "The account's display name.", type: "string" },
  5043. email: { description: "The account's email address.", type: "string" },
  5044. emailVerified: {
  5045. description: "Whether the account's email has been verified.",
  5046. type: "boolean",
  5047. },
  5048. expiresIn: {
  5049. description: "The number of seconds until the Identity Platform ID token expires.",
  5050. format: "int64",
  5051. type: "string",
  5052. },
  5053. idToken: {
  5054. description: "An Identity Platform ID token for the account. This is used for legacy user sign up.",
  5055. type: "string",
  5056. },
  5057. kind: { type: "string" },
  5058. localId: { description: "The ID of the authenticated user.", type: "string" },
  5059. newEmail: {
  5060. description: "The new email that has been set on the user's account attributes.",
  5061. type: "string",
  5062. },
  5063. passwordHash: {
  5064. description: "Deprecated. No actual password hash is currently returned.",
  5065. type: "string",
  5066. },
  5067. photoUrl: {
  5068. description: "The user's photo URL for the account's profile photo.",
  5069. type: "string",
  5070. },
  5071. providerUserInfo: {
  5072. description: "The linked Identity Providers on the account.",
  5073. items: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1ProviderUserInfo" },
  5074. type: "array",
  5075. },
  5076. refreshToken: {
  5077. description: "A refresh token for the account. This is used for legacy user sign up.",
  5078. type: "string",
  5079. },
  5080. },
  5081. type: "object",
  5082. },
  5083. GoogleCloudIdentitytoolkitV1SignInWithCustomTokenRequest: {
  5084. description: "Request message for SignInWithCustomToken.",
  5085. properties: {
  5086. delegatedProjectNumber: { format: "int64", type: "string" },
  5087. instanceId: { type: "string" },
  5088. returnSecureToken: { description: "Should always be true.", type: "boolean" },
  5089. tenantId: {
  5090. description: "The ID of the Identity Platform tenant the user is signing in to. If present, the ID should match the tenant_id in the token.",
  5091. type: "string",
  5092. },
  5093. token: {
  5094. description: 'Required. The custom Auth token asserted by the developer. The token should be a [JSON Web Token (JWT)](https://tools.ietf.org/html/rfc7519) that includes the claims listed in the [API reference](https://cloud.google.com/identity-platform/docs/reference/rest/client/) under the "Custom Token Claims" section.',
  5095. type: "string",
  5096. },
  5097. },
  5098. type: "object",
  5099. },
  5100. GoogleCloudIdentitytoolkitV1SignInWithCustomTokenResponse: {
  5101. description: "Response message for SignInWithCustomToken.",
  5102. properties: {
  5103. expiresIn: {
  5104. description: "The number of seconds until the ID token expires.",
  5105. format: "int64",
  5106. type: "string",
  5107. },
  5108. idToken: {
  5109. description: "An Identity Platform ID token for the authenticated user.",
  5110. type: "string",
  5111. },
  5112. isNewUser: {
  5113. description: "Whether the authenticated user was created by this request.",
  5114. type: "boolean",
  5115. },
  5116. kind: { type: "string" },
  5117. refreshToken: {
  5118. description: "An Identity Platform refresh token for the authenticated user.",
  5119. type: "string",
  5120. },
  5121. },
  5122. type: "object",
  5123. },
  5124. GoogleCloudIdentitytoolkitV1SignInWithEmailLinkRequest: {
  5125. description: "Request message for SignInWithEmailLink",
  5126. properties: {
  5127. email: {
  5128. description: "Required. The email address the sign-in link was sent to. The length of email should be less than 256 characters and in the format of `name@domain.tld`. The email should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec production.",
  5129. type: "string",
  5130. },
  5131. idToken: {
  5132. description: "A valid ID token for an Identity Platform account. If passed, this request will link the email address to the user represented by this ID token and enable sign-in with email link on the account for the future.",
  5133. type: "string",
  5134. },
  5135. oobCode: {
  5136. description: "Required. The out-of-band code from the email link.",
  5137. type: "string",
  5138. },
  5139. tenantId: {
  5140. description: "The ID of the Identity Platform tenant the user is signing in to. If not set, the user will sign in to the default Identity Platform project.",
  5141. type: "string",
  5142. },
  5143. },
  5144. type: "object",
  5145. },
  5146. GoogleCloudIdentitytoolkitV1SignInWithEmailLinkResponse: {
  5147. description: "Response message for SignInWithEmailLink.",
  5148. properties: {
  5149. email: {
  5150. description: "The email the user signed in with. Always present in the response.",
  5151. type: "string",
  5152. },
  5153. expiresIn: {
  5154. description: "The number of seconds until the ID token expires.",
  5155. format: "int64",
  5156. type: "string",
  5157. },
  5158. idToken: {
  5159. description: "An Identity Platform ID token for the authenticated user.",
  5160. type: "string",
  5161. },
  5162. isNewUser: {
  5163. description: "Whether the authenticated user was created by this request.",
  5164. type: "boolean",
  5165. },
  5166. kind: { type: "string" },
  5167. localId: {
  5168. description: "The ID of the authenticated user. Always present in the response.",
  5169. type: "string",
  5170. },
  5171. mfaInfo: {
  5172. description: "Info on which multi-factor authentication providers are enabled. Present if the user needs to complete the sign-in using multi-factor authentication.",
  5173. items: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1MfaEnrollment" },
  5174. type: "array",
  5175. },
  5176. mfaPendingCredential: {
  5177. description: "An opaque string that functions as proof that the user has successfully passed the first factor check.",
  5178. type: "string",
  5179. },
  5180. refreshToken: {
  5181. description: "Refresh token for the authenticated user.",
  5182. type: "string",
  5183. },
  5184. },
  5185. type: "object",
  5186. },
  5187. GoogleCloudIdentitytoolkitV1SignInWithGameCenterRequest: {
  5188. description: "Request message for SignInWithGameCenter",
  5189. properties: {
  5190. displayName: { description: "The user's Game Center display name.", type: "string" },
  5191. idToken: {
  5192. description: "A valid ID token for an Identity Platform account. If present, this request will link the Game Center player ID to the account represented by this ID token.",
  5193. type: "string",
  5194. },
  5195. playerId: { description: "Required. The user's Game Center player ID.", type: "string" },
  5196. publicKeyUrl: {
  5197. description: "Required. The URL to fetch the Apple public key in order to verify the given signature is signed by Apple.",
  5198. type: "string",
  5199. },
  5200. salt: {
  5201. description: "Required. A random string used to generate the given signature.",
  5202. type: "string",
  5203. },
  5204. signature: {
  5205. description: "Required. The verification signature data generated by Apple.",
  5206. type: "string",
  5207. },
  5208. tenantId: {
  5209. description: "The ID of the Identity Platform tenant the user is signing in to.",
  5210. type: "string",
  5211. },
  5212. timestamp: {
  5213. description: "Required. The time when the signature was created by Apple, in milliseconds since the epoch.",
  5214. format: "int64",
  5215. type: "string",
  5216. },
  5217. },
  5218. type: "object",
  5219. },
  5220. GoogleCloudIdentitytoolkitV1SignInWithGameCenterResponse: {
  5221. description: "Response message for SignInWithGameCenter",
  5222. properties: {
  5223. displayName: { description: "Display name of the authenticated user.", type: "string" },
  5224. expiresIn: {
  5225. description: "The number of seconds until the ID token expires.",
  5226. format: "int64",
  5227. type: "string",
  5228. },
  5229. idToken: {
  5230. description: "An Identity Platform ID token for the authenticated user.",
  5231. type: "string",
  5232. },
  5233. isNewUser: {
  5234. description: "Whether the logged in user was created by this request.",
  5235. type: "boolean",
  5236. },
  5237. localId: {
  5238. description: "The ID of the authenticated user. Always present in the response.",
  5239. type: "string",
  5240. },
  5241. playerId: { description: "The user's Game Center player ID.", type: "string" },
  5242. refreshToken: {
  5243. description: "An Identity Platform refresh token for the authenticated user.",
  5244. type: "string",
  5245. },
  5246. },
  5247. type: "object",
  5248. },
  5249. GoogleCloudIdentitytoolkitV1SignInWithIdpRequest: {
  5250. description: "Request message for SignInWithIdp.",
  5251. properties: {
  5252. autoCreate: { type: "boolean" },
  5253. delegatedProjectNumber: { format: "int64", type: "string" },
  5254. idToken: {
  5255. description: "A valid Identity Platform ID token. If passed, the user's account at the IdP will be linked to the account represented by this ID token.",
  5256. type: "string",
  5257. },
  5258. pendingIdToken: { type: "string" },
  5259. pendingToken: {
  5260. description: "An opaque string from a previous SignInWithIdp response. If set, it can be used to repeat the sign-in operation from the previous SignInWithIdp operation.",
  5261. type: "string",
  5262. },
  5263. postBody: {
  5264. description: "If the user is signing in with an authorization response obtained via a previous CreateAuthUri authorization request, this is the body of the HTTP POST callback from the IdP, if present. Otherwise, if the user is signing in with a manually provided IdP credential, this should be a URL-encoded form that contains the credential (e.g. an ID token or access token for OAuth 2.0 IdPs) and the provider ID of the IdP that issued the credential. For example, if the user is signing in to the Google provider using a Google ID token, this should be set to `id_token=[GOOGLE_ID_TOKEN]&providerId=google.com`, where `[GOOGLE_ID_TOKEN]` should be replaced with the Google ID token. If the user is signing in to the Facebook provider using a Facebook authentication token, this should be set to `id_token=[FACEBOOK_AUTHENTICATION_TOKEN]&providerId=facebook.com&nonce= [NONCE]`, where `[FACEBOOK_AUTHENTICATION_TOKEN]` should be replaced with the Facebook authentication token. Nonce is required for validating the token. The request will fail if no nonce is provided. If the user is signing in to the Facebook provider using a Facebook access token, this should be set to `access_token=[FACEBOOK_ACCESS_TOKEN]&providerId=facebook.com`, where `[FACEBOOK_ACCESS_TOKEN]` should be replaced with the Facebook access token. If the user is signing in to the Twitter provider using a Twitter OAuth 1.0 credential, this should be set to `access_token=[TWITTER_ACCESS_TOKEN]&oauth_token_secret=[TWITTER_TOKEN_SECRET]&providerId=twitter.com`, where `[TWITTER_ACCESS_TOKEN]` and `[TWITTER_TOKEN_SECRET]` should be replaced with the Twitter OAuth access token and Twitter OAuth token secret respectively.",
  5265. type: "string",
  5266. },
  5267. requestUri: {
  5268. description: "Required. The URL to which the IdP redirects the user back. This can be set to `http://localhost` if the user is signing in with a manually provided IdP credential.",
  5269. type: "string",
  5270. },
  5271. returnIdpCredential: {
  5272. description: "Whether or not to return OAuth credentials from the IdP on the following errors: `FEDERATED_USER_ID_ALREADY_LINKED` and `EMAIL_EXISTS`.",
  5273. type: "boolean",
  5274. },
  5275. returnRefreshToken: {
  5276. description: "Whether or not to return the OAuth refresh token from the IdP, if available.",
  5277. type: "boolean",
  5278. },
  5279. returnSecureToken: { description: "Should always be true.", type: "boolean" },
  5280. sessionId: {
  5281. description: "The session ID returned from a previous CreateAuthUri call. This field is verified against that session ID to prevent session fixation attacks. Required if the user is signing in with an authorization response from a previous CreateAuthUri authorization request.",
  5282. type: "string",
  5283. },
  5284. tenantId: {
  5285. description: "The ID of the Identity Platform tenant the user is signing in to. If not set, the user will sign in to the default Identity Platform project.",
  5286. type: "string",
  5287. },
  5288. },
  5289. type: "object",
  5290. },
  5291. GoogleCloudIdentitytoolkitV1SignInWithIdpResponse: {
  5292. description: "Response message for SignInWithIdp.",
  5293. properties: {
  5294. context: {
  5295. description: "The opaque string set in CreateAuthUri that is used to maintain contextual information between the authentication request and the callback from the IdP.",
  5296. type: "string",
  5297. },
  5298. dateOfBirth: {
  5299. description: "The date of birth for the user's account at the IdP.",
  5300. type: "string",
  5301. },
  5302. displayName: {
  5303. description: "The display name for the user's account at the IdP.",
  5304. type: "string",
  5305. },
  5306. email: {
  5307. description: "The email address of the user's account at the IdP.",
  5308. type: "string",
  5309. },
  5310. emailRecycled: {
  5311. description: 'Whether or not there is an existing Identity Platform user account with the same email address but linked to a different account at the same IdP. Only present if the "One account per email address" setting is enabled and the email address at the IdP is verified.',
  5312. type: "boolean",
  5313. },
  5314. emailVerified: {
  5315. description: "Whether the user account's email address is verified.",
  5316. type: "boolean",
  5317. },
  5318. errorMessage: {
  5319. description: "The error message returned if `return_idp_credential` is set to `true` and either the `FEDERATED_USER_ID_ALREADY_LINKED` or `EMAIL_EXISTS` error is encountered. This field's value is either `FEDERATED_USER_ID_ALREADY_LINKED` or `EMAIL_EXISTS`.",
  5320. type: "string",
  5321. },
  5322. expiresIn: {
  5323. description: "The number of seconds until the Identity Platform ID token expires.",
  5324. format: "int64",
  5325. type: "string",
  5326. },
  5327. federatedId: {
  5328. description: "The user's account ID at the IdP. Always present in the response.",
  5329. type: "string",
  5330. },
  5331. firstName: {
  5332. description: "The first name for the user's account at the IdP.",
  5333. type: "string",
  5334. },
  5335. fullName: {
  5336. description: "The full name for the user's account at the IdP.",
  5337. type: "string",
  5338. },
  5339. idToken: {
  5340. description: "An Identity Platform ID token for the authenticated user.",
  5341. type: "string",
  5342. },
  5343. inputEmail: { type: "string" },
  5344. isNewUser: {
  5345. description: "Whether or not a new Identity Platform account was created for the authenticated user.",
  5346. type: "boolean",
  5347. },
  5348. kind: { type: "string" },
  5349. language: {
  5350. description: "The language preference for the user's account at the IdP.",
  5351. type: "string",
  5352. },
  5353. lastName: {
  5354. description: "The last name for the user's account at the IdP.",
  5355. type: "string",
  5356. },
  5357. localId: {
  5358. description: "The ID of the authenticated Identity Platform user. Always present in the response.",
  5359. type: "string",
  5360. },
  5361. mfaInfo: {
  5362. description: "Info on which multi-factor authentication providers are enabled for the account. Present if the user needs to complete the sign-in using multi-factor authentication.",
  5363. items: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1MfaEnrollment" },
  5364. type: "array",
  5365. },
  5366. mfaPendingCredential: {
  5367. description: "An opaque string that functions as proof that the user has successfully passed the first factor authentication.",
  5368. type: "string",
  5369. },
  5370. needConfirmation: {
  5371. description: 'Whether or not there is an existing Identity Platform user account with the same email address as the current account signed in at the IdP, and the account\'s email addresss is not verified at the IdP. The user will need to sign in to the existing Identity Platform account and then link the current credential from the IdP to it. Only present if the "One account per email address" setting is enabled.',
  5372. type: "boolean",
  5373. },
  5374. needEmail: { type: "boolean" },
  5375. nickName: {
  5376. description: "The nickname for the user's account at the IdP.",
  5377. type: "string",
  5378. },
  5379. oauthAccessToken: {
  5380. description: "The OAuth access token from the IdP, if available.",
  5381. type: "string",
  5382. },
  5383. oauthAuthorizationCode: {
  5384. description: "The OAuth 2.0 authorization code, if available. Only present for the Google provider.",
  5385. type: "string",
  5386. },
  5387. oauthExpireIn: {
  5388. description: "The number of seconds until the OAuth access token from the IdP expires.",
  5389. format: "int32",
  5390. type: "integer",
  5391. },
  5392. oauthIdToken: {
  5393. description: "The OpenID Connect ID token from the IdP, if available.",
  5394. type: "string",
  5395. },
  5396. oauthRefreshToken: {
  5397. description: "The OAuth 2.0 refresh token from the IdP, if available and `return_refresh_token` is set to `true`.",
  5398. type: "string",
  5399. },
  5400. oauthTokenSecret: {
  5401. description: "The OAuth 1.0 token secret from the IdP, if available. Only present for the Twitter provider.",
  5402. type: "string",
  5403. },
  5404. originalEmail: {
  5405. description: 'The main (top-level) email address of the user\'s Identity Platform account, if different from the email address at the IdP. Only present if the "One account per email address" setting is enabled.',
  5406. type: "string",
  5407. },
  5408. pendingToken: {
  5409. description: "An opaque string that can be used as a credential from the IdP the user is signing into. The pending token obtained here can be set in a future SignInWithIdp request to sign the same user in with the IdP again.",
  5410. type: "string",
  5411. },
  5412. photoUrl: {
  5413. description: "The URL of the user's profile picture at the IdP.",
  5414. type: "string",
  5415. },
  5416. providerId: {
  5417. description: "The provider ID of the IdP that the user is signing in to. Always present in the response.",
  5418. type: "string",
  5419. },
  5420. rawUserInfo: {
  5421. description: "The stringified JSON response containing all the data corresponding to the user's account at the IdP.",
  5422. type: "string",
  5423. },
  5424. refreshToken: {
  5425. description: "An Identity Platform refresh token for the authenticated user.",
  5426. type: "string",
  5427. },
  5428. screenName: {
  5429. description: "The screen name for the user's account at the Twitter IdP or the login name for the user's account at the GitHub IdP.",
  5430. type: "string",
  5431. },
  5432. tenantId: {
  5433. description: "The value of the `tenant_id` field in the request.",
  5434. type: "string",
  5435. },
  5436. timeZone: {
  5437. description: "The time zone for the user's account at the IdP.",
  5438. type: "string",
  5439. },
  5440. verifiedProvider: {
  5441. description: "A list of provider IDs that the user can sign in to in order to resolve a `need_confirmation` error. Only present if `need_confirmation` is set to `true`.",
  5442. items: { type: "string" },
  5443. type: "array",
  5444. },
  5445. },
  5446. type: "object",
  5447. },
  5448. GoogleCloudIdentitytoolkitV1SignInWithPasswordRequest: {
  5449. description: "Request message for SignInWithPassword.",
  5450. properties: {
  5451. captchaChallenge: { type: "string" },
  5452. captchaResponse: {
  5453. description: "The reCAPTCHA token provided by the reCAPTCHA client-side integration. reCAPTCHA Enterprise uses it for risk assessment. Required when reCAPTCHA Enterprise is enabled.",
  5454. type: "string",
  5455. },
  5456. delegatedProjectNumber: { format: "int64", type: "string" },
  5457. email: {
  5458. description: "Required. The email the user is signing in with. The length of email should be less than 256 characters and in the format of `name@domain.tld`. The email should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec production.",
  5459. type: "string",
  5460. },
  5461. idToken: { type: "string" },
  5462. instanceId: { type: "string" },
  5463. password: {
  5464. description: "Required. The password the user provides to sign in to the account.",
  5465. type: "string",
  5466. },
  5467. pendingIdToken: { type: "string" },
  5468. returnSecureToken: { description: "Should always be true.", type: "boolean" },
  5469. tenantId: {
  5470. description: "The ID of the Identity Platform tenant the user is signing in to. If not set, the user will sign in to the default Identity Platform instance in the project.",
  5471. type: "string",
  5472. },
  5473. },
  5474. type: "object",
  5475. },
  5476. GoogleCloudIdentitytoolkitV1SignInWithPasswordResponse: {
  5477. description: "Response message for SignInWithPassword.",
  5478. properties: {
  5479. displayName: {
  5480. description: "The user's display name stored in the account's attributes.",
  5481. type: "string",
  5482. },
  5483. email: {
  5484. description: "The email of the authenticated user. Always present in the response.",
  5485. type: "string",
  5486. },
  5487. expiresIn: {
  5488. description: "The number of seconds until the Identity Platform ID token expires.",
  5489. format: "int64",
  5490. type: "string",
  5491. },
  5492. idToken: {
  5493. description: "An Identity Platform ID token for the authenticated user.",
  5494. type: "string",
  5495. },
  5496. kind: { type: "string" },
  5497. localId: {
  5498. description: "The ID of the authenticated user. Always present in the response.",
  5499. type: "string",
  5500. },
  5501. mfaInfo: {
  5502. description: "Info on which multi-factor authentication providers are enabled for the account. Present if the user needs to complete the sign-in using multi-factor authentication.",
  5503. items: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1MfaEnrollment" },
  5504. type: "array",
  5505. },
  5506. mfaPendingCredential: {
  5507. description: "An opaque string that functions as proof that the user has successfully passed the first factor authentication.",
  5508. type: "string",
  5509. },
  5510. oauthAccessToken: { description: "The OAuth2 access token.", type: "string" },
  5511. oauthAuthorizationCode: { type: "string" },
  5512. oauthExpireIn: {
  5513. description: "The access token expiration time in seconds.",
  5514. format: "int32",
  5515. type: "integer",
  5516. },
  5517. profilePicture: {
  5518. description: "The user's profile picture stored in the account's attributes.",
  5519. type: "string",
  5520. },
  5521. refreshToken: {
  5522. description: "An Identity Platform refresh token for the authenticated user.",
  5523. type: "string",
  5524. },
  5525. registered: {
  5526. description: "Whether the email is for an existing account. Always true.",
  5527. type: "boolean",
  5528. },
  5529. },
  5530. type: "object",
  5531. },
  5532. GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberRequest: {
  5533. description: "Request message for SignInWithPhoneNumber.",
  5534. properties: {
  5535. code: {
  5536. description: "User-entered verification code from an SMS sent to the user's phone.",
  5537. type: "string",
  5538. },
  5539. idToken: {
  5540. description: "A valid ID token for an Identity Platform account. If passed, this request will link the phone number to the user represented by this ID token if the phone number is not in use, or will reauthenticate the user if the phone number is already linked to the user.",
  5541. type: "string",
  5542. },
  5543. operation: {
  5544. enum: ["VERIFY_OP_UNSPECIFIED", "SIGN_UP_OR_IN", "REAUTH", "UPDATE", "LINK"],
  5545. type: "string",
  5546. },
  5547. phoneNumber: {
  5548. description: "The user's phone number to sign in with. This is necessary in the case of uing a temporary proof, in which case it must match the phone number that was authenticated in the request that generated the temporary proof. This field is ignored if a session info is passed.",
  5549. type: "string",
  5550. },
  5551. sessionInfo: {
  5552. description: "Encrypted session information from the response of sendVerificationCode. In the case of authenticating with an SMS code this must be specified, but in the case of using a temporary proof it can be unspecified.",
  5553. type: "string",
  5554. },
  5555. temporaryProof: {
  5556. description: "A proof of the phone number verification, provided from a previous signInWithPhoneNumber request. If this is passed, the caller must also pass in the phone_number field the phone number that was verified in the previous request.",
  5557. type: "string",
  5558. },
  5559. tenantId: {
  5560. description: "The ID of the Identity Platform tenant the user is signing in to. If not set, the user will sign in to the default Identity Platform project.",
  5561. type: "string",
  5562. },
  5563. verificationProof: { description: "Do not use.", type: "string" },
  5564. },
  5565. type: "object",
  5566. },
  5567. GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberResponse: {
  5568. description: "Response message for SignInWithPhoneNumber.",
  5569. properties: {
  5570. expiresIn: {
  5571. description: "The number of seconds until the ID token expires.",
  5572. format: "int64",
  5573. type: "string",
  5574. },
  5575. idToken: {
  5576. description: "Identity Platform ID token for the authenticated user.",
  5577. type: "string",
  5578. },
  5579. isNewUser: {
  5580. description: "Whether the authenticated user was created by this request.",
  5581. type: "boolean",
  5582. },
  5583. localId: {
  5584. description: "The id of the authenticated user. Present in the case of a successful authentication. In the case when the phone could be verified but the account operation could not be performed, a temporary proof will be returned instead.",
  5585. type: "string",
  5586. },
  5587. phoneNumber: {
  5588. description: "Phone number of the authenticated user. Always present in the response.",
  5589. type: "string",
  5590. },
  5591. refreshToken: {
  5592. description: "Refresh token for the authenticated user.",
  5593. type: "string",
  5594. },
  5595. temporaryProof: {
  5596. description: "A proof of the phone number verification, provided if a phone authentication is successful but the user operation fails. This happens when the request tries to link a phone number to a user with an ID token or reauthenticate with an ID token but the phone number is linked to a different user.",
  5597. type: "string",
  5598. },
  5599. temporaryProofExpiresIn: {
  5600. description: "The number of seconds until the temporary proof expires.",
  5601. format: "int64",
  5602. type: "string",
  5603. },
  5604. verificationProof: { description: "Do not use.", type: "string" },
  5605. verificationProofExpiresIn: {
  5606. description: "Do not use.",
  5607. format: "int64",
  5608. type: "string",
  5609. },
  5610. },
  5611. type: "object",
  5612. },
  5613. GoogleCloudIdentitytoolkitV1SignUpRequest: {
  5614. description: "Request message for SignUp.",
  5615. properties: {
  5616. captchaChallenge: { type: "string" },
  5617. captchaResponse: {
  5618. description: "The reCAPTCHA token provided by the reCAPTCHA client-side integration. reCAPTCHA Enterprise uses it for assessment. Required when reCAPTCHA enterprise is enabled.",
  5619. type: "string",
  5620. },
  5621. disabled: {
  5622. description: "Whether the user will be disabled upon creation. Disabled accounts are inaccessible except for requests bearing a Google OAuth2 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).",
  5623. type: "boolean",
  5624. },
  5625. displayName: {
  5626. description: "The display name of the user to be created.",
  5627. type: "string",
  5628. },
  5629. email: {
  5630. description: "The email to assign to the created user. The length of the email should be less than 256 characters and in the format of `name@domain.tld`. The email should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec production. An anonymous user will be created if not provided.",
  5631. type: "string",
  5632. },
  5633. emailVerified: {
  5634. description: "Whether the user's email is verified. Specifying this field requires a Google OAuth 2.0 credential with the proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).",
  5635. type: "boolean",
  5636. },
  5637. idToken: {
  5638. description: "A valid ID token for an Identity Platform user. If set, this request will link the authentication credential to the user represented by this ID token. For a non-admin request, both the `email` and `password` fields must be set. For an admin request, `local_id` must not be set.",
  5639. type: "string",
  5640. },
  5641. instanceId: { type: "string" },
  5642. localId: {
  5643. description: "The ID of the user to create. The ID must be unique within the project that the user is being created under. Specifying this field requires a Google OAuth 2.0 credential with the proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).",
  5644. type: "string",
  5645. },
  5646. mfaInfo: {
  5647. description: "The multi-factor authentication providers for the user to create.",
  5648. items: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1MfaFactor" },
  5649. type: "array",
  5650. },
  5651. password: {
  5652. description: "The password to assign to the created user. The password must be be at least 6 characters long. If set, the `email` field must also be set.",
  5653. type: "string",
  5654. },
  5655. phoneNumber: {
  5656. description: "The phone number of the user to create. Specifying this field requires a Google OAuth 2.0 credential with the proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).",
  5657. type: "string",
  5658. },
  5659. photoUrl: { description: "The profile photo url of the user to create.", type: "string" },
  5660. targetProjectId: {
  5661. description: "The project ID of the project which the user should belong to. Specifying this field requires a Google OAuth 2.0 credential with the proper [permissions](https://cloud.google.com/identity-platform/docs/access-control). If this is not set, the target project is inferred from the scope associated to the Bearer access token.",
  5662. type: "string",
  5663. },
  5664. tenantId: {
  5665. description: "The ID of the Identity Platform tenant to create a user under. If not set, the user will be created under the default Identity Platform project.",
  5666. type: "string",
  5667. },
  5668. },
  5669. type: "object",
  5670. },
  5671. GoogleCloudIdentitytoolkitV1SignUpResponse: {
  5672. description: "Response message for SignUp.",
  5673. properties: {
  5674. displayName: { description: "The created user's display name.", type: "string" },
  5675. email: { description: "The created user's email.", type: "string" },
  5676. expiresIn: {
  5677. description: "The number of seconds until the ID token expires.",
  5678. format: "int64",
  5679. type: "string",
  5680. },
  5681. idToken: {
  5682. description: "An Identity Platform ID token for the created user. This field is only set for non-admin requests.",
  5683. type: "string",
  5684. },
  5685. kind: { type: "string" },
  5686. localId: {
  5687. description: "The ID of the created user. Always present in the response.",
  5688. type: "string",
  5689. },
  5690. refreshToken: {
  5691. description: "An Identity Platform refresh token for the created user. This field is only set for non-admin requests.",
  5692. type: "string",
  5693. },
  5694. },
  5695. type: "object",
  5696. },
  5697. GoogleCloudIdentitytoolkitV1SqlExpression: {
  5698. description: "Query conditions used to filter results.",
  5699. properties: {
  5700. email: {
  5701. description: "A case insensitive string that the account's email should match. Only one of `email`, `phone_number`, or `user_id` should be specified in a SqlExpression. If more than one is specified, only the first (in that order) will be applied.",
  5702. type: "string",
  5703. },
  5704. phoneNumber: {
  5705. description: "A string that the account's phone number should match. Only one of `email`, `phone_number`, or `user_id` should be specified in a SqlExpression. If more than one is specified, only the first (in that order) will be applied.",
  5706. type: "string",
  5707. },
  5708. userId: {
  5709. description: "A string that the account's local ID should match. Only one of `email`, `phone_number`, or `user_id` should be specified in a SqlExpression If more than one is specified, only the first (in that order) will be applied.",
  5710. type: "string",
  5711. },
  5712. },
  5713. type: "object",
  5714. },
  5715. GoogleCloudIdentitytoolkitV1UploadAccountRequest: {
  5716. description: "Request message for UploadAccount.",
  5717. properties: {
  5718. allowOverwrite: {
  5719. description: "Whether to overwrite an existing account in Identity Platform with a matching `local_id` in the request. If true, the existing account will be overwritten. If false, an error will be returned.",
  5720. type: "boolean",
  5721. },
  5722. argon2Parameters: {
  5723. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1Argon2Parameters",
  5724. },
  5725. blockSize: {
  5726. description: "The block size parameter used by the STANDARD_SCRYPT hashing function. This parameter, along with parallelization and cpu_mem_cost help tune the resources needed to hash a password, and should be tuned as processor speeds and memory technologies advance.",
  5727. format: "int32",
  5728. type: "integer",
  5729. },
  5730. cpuMemCost: {
  5731. description: "The CPU memory cost parameter to be used by the STANDARD_SCRYPT hashing function. This parameter, along with block_size and cpu_mem_cost help tune the resources needed to hash a password, and should be tuned as processor speeds and memory technologies advance.",
  5732. format: "int32",
  5733. type: "integer",
  5734. },
  5735. delegatedProjectNumber: { format: "int64", type: "string" },
  5736. dkLen: {
  5737. description: "The desired key length for the STANDARD_SCRYPT hashing function. Must be at least 1.",
  5738. format: "int32",
  5739. type: "integer",
  5740. },
  5741. hashAlgorithm: {
  5742. description: "Required. The hashing function used to hash the account passwords. Must be one of the following: * HMAC_SHA256 * HMAC_SHA1 * HMAC_MD5 * SCRYPT * PBKDF_SHA1 * MD5 * HMAC_SHA512 * SHA1 * BCRYPT * PBKDF2_SHA256 * SHA256 * SHA512 * STANDARD_SCRYPT * ARGON2",
  5743. type: "string",
  5744. },
  5745. memoryCost: {
  5746. description: "Memory cost for hash calculation. Only required when the hashing function is SCRYPT.",
  5747. format: "int32",
  5748. type: "integer",
  5749. },
  5750. parallelization: {
  5751. description: "The parallelization cost parameter to be used by the STANDARD_SCRYPT hashing function. This parameter, along with block_size and cpu_mem_cost help tune the resources needed to hash a password, and should be tuned as processor speeds and memory technologies advance.",
  5752. format: "int32",
  5753. type: "integer",
  5754. },
  5755. passwordHashOrder: {
  5756. description: "Password and salt order when verify password.",
  5757. enum: ["UNSPECIFIED_ORDER", "SALT_AND_PASSWORD", "PASSWORD_AND_SALT"],
  5758. type: "string",
  5759. },
  5760. rounds: {
  5761. description: "The number of rounds used for hash calculation. Only required for the following hashing functions: * MD5 * SHA1 * SHA256 * SHA512 * PBKDF_SHA1 * PBKDF2_SHA256 * SCRYPT",
  5762. format: "int32",
  5763. type: "integer",
  5764. },
  5765. saltSeparator: {
  5766. description: "One or more bytes to be inserted between the salt and plain text password. For stronger security, this should be a single non-printable character.",
  5767. format: "byte",
  5768. type: "string",
  5769. },
  5770. sanityCheck: {
  5771. description: "If true, the service will do the following list of checks before an account is uploaded: * Duplicate emails * Duplicate federated IDs * Federated ID provider validation If the duplication exists within the list of accounts to be uploaded, it will prevent the entire list from being uploaded. If the email or federated ID is a duplicate of a user already within the project/tenant, the account will not be uploaded, but the rest of the accounts will be unaffected. If false, these checks will be skipped.",
  5772. type: "boolean",
  5773. },
  5774. signerKey: {
  5775. description: "The signer key used to hash the password. Required for the following hashing functions: * SCRYPT, * HMAC_MD5, * HMAC_SHA1, * HMAC_SHA256, * HMAC_SHA512",
  5776. format: "byte",
  5777. type: "string",
  5778. },
  5779. tenantId: {
  5780. description: "The ID of the Identity Platform tenant the account belongs to.",
  5781. type: "string",
  5782. },
  5783. users: {
  5784. description: "A list of accounts to upload. `local_id` is required for each user; everything else is optional.",
  5785. items: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1UserInfo" },
  5786. type: "array",
  5787. },
  5788. },
  5789. type: "object",
  5790. },
  5791. GoogleCloudIdentitytoolkitV1UploadAccountResponse: {
  5792. description: "Response message for UploadAccount.",
  5793. properties: {
  5794. error: {
  5795. description: "Detailed error info for accounts that cannot be uploaded.",
  5796. items: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1ErrorInfo" },
  5797. type: "array",
  5798. },
  5799. kind: { type: "string" },
  5800. },
  5801. type: "object",
  5802. },
  5803. GoogleCloudIdentitytoolkitV1UserInfo: {
  5804. description: "An Identity Platform account's information.",
  5805. properties: {
  5806. createdAt: {
  5807. description: "The time, in milliseconds from epoch, when the account was created.",
  5808. format: "int64",
  5809. type: "string",
  5810. },
  5811. customAttributes: {
  5812. description: "Custom claims to be added to any ID tokens minted for the account. Should be at most 1,000 characters in length and in valid JSON format.",
  5813. type: "string",
  5814. },
  5815. customAuth: {
  5816. description: "Output only. Whether this account has been authenticated using SignInWithCustomToken.",
  5817. readOnly: true,
  5818. type: "boolean",
  5819. },
  5820. dateOfBirth: {
  5821. description: "Output only. The date of birth set for the account. This account attribute is not used by Identity Platform. It is available for informational purposes only.",
  5822. readOnly: true,
  5823. type: "string",
  5824. },
  5825. disabled: {
  5826. description: "Whether the account is disabled. Disabled accounts are inaccessible except for requests bearing a Google OAuth2 credential with proper permissions.",
  5827. type: "boolean",
  5828. },
  5829. displayName: {
  5830. description: "The display name of the account. This account attribute is not used by Identity Platform. It is available for informational purposes only.",
  5831. type: "string",
  5832. },
  5833. email: {
  5834. description: "The account's email address. The length of the email should be less than 256 characters and in the format of `name@domain.tld`. The email should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec.",
  5835. type: "string",
  5836. },
  5837. emailLinkSignin: {
  5838. description: "Output only. Whether the account can authenticate with email link.",
  5839. readOnly: true,
  5840. type: "boolean",
  5841. },
  5842. emailVerified: {
  5843. description: "Whether the account's email address has been verified.",
  5844. type: "boolean",
  5845. },
  5846. initialEmail: {
  5847. description: "The first email address associated with this account. The account's initial email cannot be changed once set and is used to recover access to this account if lost via the RECOVER_EMAIL flow in GetOobCode. Should match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec.",
  5848. type: "string",
  5849. },
  5850. language: {
  5851. description: "Output only. The language preference of the account. This account attribute is not used by Identity Platform. It is available for informational purposes only.",
  5852. readOnly: true,
  5853. type: "string",
  5854. },
  5855. lastLoginAt: {
  5856. description: "The last time, in milliseconds from epoch, this account was logged into.",
  5857. format: "int64",
  5858. type: "string",
  5859. },
  5860. lastRefreshAt: {
  5861. description: "Timestamp when an ID token was last minted for this account.",
  5862. format: "google-datetime",
  5863. type: "string",
  5864. },
  5865. localId: { description: "Immutable. The unique ID of the account.", type: "string" },
  5866. mfaInfo: {
  5867. description: "Information on which multi-factor authentication providers are enabled for this account.",
  5868. items: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1MfaEnrollment" },
  5869. type: "array",
  5870. },
  5871. passwordHash: {
  5872. description: "The account's hashed password. Only accessible by requests bearing a Google OAuth2 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).",
  5873. format: "byte",
  5874. type: "string",
  5875. },
  5876. passwordUpdatedAt: {
  5877. description: "The timestamp, in milliseconds from the epoch of 1970-01-01T00:00:00Z, when the account's password was last updated.",
  5878. format: "double",
  5879. type: "number",
  5880. },
  5881. phoneNumber: { description: "The account's phone number.", type: "string" },
  5882. photoUrl: {
  5883. description: "The URL of the account's profile photo. This account attribute is not used by Identity Platform. It is available for informational purposes only.",
  5884. type: "string",
  5885. },
  5886. providerUserInfo: {
  5887. description: "Information about the user as provided by various Identity Providers.",
  5888. items: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1ProviderUserInfo" },
  5889. type: "array",
  5890. },
  5891. rawPassword: {
  5892. description: "Input only. Plain text password used to update a account's password. This field is only ever used as input in a request. Identity Platform uses cryptographically secure hashing when managing passwords and will never store or transmit a user's password in plain text.",
  5893. type: "string",
  5894. },
  5895. salt: {
  5896. description: "The account's password salt. Only accessible by requests bearing a Google OAuth2 credential with proper permissions.",
  5897. format: "byte",
  5898. type: "string",
  5899. },
  5900. screenName: {
  5901. description: "Output only. This account's screen name at Twitter or login name at GitHub.",
  5902. readOnly: true,
  5903. type: "string",
  5904. },
  5905. tenantId: {
  5906. description: "ID of the tenant this account belongs to. Only set if this account belongs to a tenant.",
  5907. type: "string",
  5908. },
  5909. timeZone: {
  5910. description: "Output only. The time zone preference of the account. This account attribute is not used by Identity Platform. It is available for informational purposes only.",
  5911. readOnly: true,
  5912. type: "string",
  5913. },
  5914. validSince: {
  5915. description: "Oldest timestamp, in seconds since epoch, that an ID token should be considered valid. All ID tokens issued before this time are considered invalid.",
  5916. format: "int64",
  5917. type: "string",
  5918. },
  5919. version: {
  5920. description: "The version of the account's password. Only accessible by requests bearing a Google OAuth2 credential with proper permissions.",
  5921. format: "int32",
  5922. type: "integer",
  5923. },
  5924. },
  5925. type: "object",
  5926. },
  5927. GoogleCloudIdentitytoolkitV1VerifyIosClientRequest: {
  5928. description: "Request message for VerifyIosClient",
  5929. properties: {
  5930. appToken: {
  5931. description: "A device token that the iOS client gets after registering to APNs (Apple Push Notification service).",
  5932. type: "string",
  5933. },
  5934. isSandbox: {
  5935. description: "Whether the app token is in the iOS sandbox. If false, the app token is in the production environment.",
  5936. type: "boolean",
  5937. },
  5938. },
  5939. type: "object",
  5940. },
  5941. GoogleCloudIdentitytoolkitV1VerifyIosClientResponse: {
  5942. description: "Response message for VerifyIosClient.",
  5943. properties: {
  5944. receipt: { description: "Receipt of successful app token validation.", type: "string" },
  5945. suggestedTimeout: {
  5946. description: "Suggested time that the client should wait in seconds for delivery of the push notification.",
  5947. format: "int64",
  5948. type: "string",
  5949. },
  5950. },
  5951. type: "object",
  5952. },
  5953. GoogleCloudIdentitytoolkitAdminV2AllowByDefault: {
  5954. description: "Defines a policy of allowing every region by default and adding disallowed regions to a disallow list.",
  5955. properties: {
  5956. disallowedRegions: {
  5957. description: "Two letter unicode region codes to disallow as defined by https://cldr.unicode.org/ The full list of these region codes is here: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json",
  5958. items: { type: "string" },
  5959. type: "array",
  5960. },
  5961. },
  5962. type: "object",
  5963. },
  5964. GoogleCloudIdentitytoolkitAdminV2AllowlistOnly: {
  5965. description: "Defines a policy of only allowing regions by explicitly adding them to an allowlist.",
  5966. properties: {
  5967. allowedRegions: {
  5968. description: "Two letter unicode region codes to allow as defined by https://cldr.unicode.org/ The full list of these region codes is here: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json",
  5969. items: { type: "string" },
  5970. type: "array",
  5971. },
  5972. },
  5973. type: "object",
  5974. },
  5975. GoogleCloudIdentitytoolkitAdminV2Anonymous: {
  5976. description: "Configuration options related to authenticating an anonymous user.",
  5977. properties: {
  5978. enabled: {
  5979. description: "Whether anonymous user auth is enabled for the project or not.",
  5980. type: "boolean",
  5981. },
  5982. },
  5983. type: "object",
  5984. },
  5985. GoogleCloudIdentitytoolkitAdminV2AppleSignInConfig: {
  5986. description: "Additional config for SignInWithApple.",
  5987. properties: {
  5988. bundleIds: {
  5989. description: "A list of Bundle ID's usable by this project",
  5990. items: { type: "string" },
  5991. type: "array",
  5992. },
  5993. codeFlowConfig: {
  5994. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2CodeFlowConfig",
  5995. },
  5996. },
  5997. type: "object",
  5998. },
  5999. GoogleCloudIdentitytoolkitAdminV2BlockingFunctionsConfig: {
  6000. description: "Configuration related to Blocking Functions.",
  6001. properties: {
  6002. forwardInboundCredentials: {
  6003. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2ForwardInboundCredentials",
  6004. },
  6005. triggers: {
  6006. additionalProperties: {
  6007. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2Trigger",
  6008. },
  6009. description: 'Map of Trigger to event type. Key should be one of the supported event types: "beforeCreate", "beforeSignIn"',
  6010. type: "object",
  6011. },
  6012. },
  6013. type: "object",
  6014. },
  6015. GoogleCloudIdentitytoolkitAdminV2ClientConfig: {
  6016. description: "Options related to how clients making requests on behalf of a project should be configured.",
  6017. properties: {
  6018. apiKey: {
  6019. description: "Output only. API key that can be used when making requests for this project.",
  6020. readOnly: true,
  6021. type: "string",
  6022. },
  6023. firebaseSubdomain: {
  6024. description: "Output only. Firebase subdomain.",
  6025. readOnly: true,
  6026. type: "string",
  6027. },
  6028. permissions: {
  6029. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2Permissions",
  6030. },
  6031. },
  6032. type: "object",
  6033. },
  6034. GoogleCloudIdentitytoolkitAdminV2ClientPermissionConfig: {
  6035. description: "Options related to how clients making requests on behalf of a tenant should be configured.",
  6036. properties: {
  6037. permissions: {
  6038. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2ClientPermissions",
  6039. },
  6040. },
  6041. type: "object",
  6042. },
  6043. GoogleCloudIdentitytoolkitAdminV2ClientPermissions: {
  6044. description: "Configuration related to restricting a user's ability to affect their account.",
  6045. properties: {
  6046. disabledUserDeletion: {
  6047. description: "When true, end users cannot delete their account on the associated project through any of our API methods",
  6048. type: "boolean",
  6049. },
  6050. disabledUserSignup: {
  6051. description: "When true, end users cannot sign up for a new account on the associated project through any of our API methods",
  6052. type: "boolean",
  6053. },
  6054. },
  6055. type: "object",
  6056. },
  6057. GoogleCloudIdentitytoolkitAdminV2CodeFlowConfig: {
  6058. description: "Additional config for Apple for code flow.",
  6059. properties: {
  6060. keyId: { description: "Key ID for the private key.", type: "string" },
  6061. privateKey: {
  6062. description: "Private key used for signing the client secret JWT.",
  6063. type: "string",
  6064. },
  6065. teamId: { description: "Apple Developer Team ID.", type: "string" },
  6066. },
  6067. type: "object",
  6068. },
  6069. GoogleCloudIdentitytoolkitAdminV2Config: {
  6070. description: "Represents an Identity Toolkit project.",
  6071. properties: {
  6072. authorizedDomains: {
  6073. description: "List of domains authorized for OAuth redirects",
  6074. items: { type: "string" },
  6075. type: "array",
  6076. },
  6077. autodeleteAnonymousUsers: {
  6078. description: "Whether anonymous users will be auto-deleted after a period of 30 days.",
  6079. type: "boolean",
  6080. },
  6081. blockingFunctions: {
  6082. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2BlockingFunctionsConfig",
  6083. },
  6084. client: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2ClientConfig" },
  6085. emailPrivacyConfig: {
  6086. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2EmailPrivacyConfig",
  6087. },
  6088. mfa: {
  6089. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2MultiFactorAuthConfig",
  6090. },
  6091. monitoring: {
  6092. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2MonitoringConfig",
  6093. },
  6094. multiTenant: {
  6095. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2MultiTenantConfig",
  6096. },
  6097. name: {
  6098. description: 'Output only. The name of the Config resource. Example: "projects/my-awesome-project/config"',
  6099. readOnly: true,
  6100. type: "string",
  6101. },
  6102. notification: {
  6103. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2NotificationConfig",
  6104. },
  6105. quota: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2QuotaConfig" },
  6106. signIn: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2SignInConfig" },
  6107. smsRegionConfig: {
  6108. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2SmsRegionConfig",
  6109. },
  6110. subtype: {
  6111. description: "Output only. The subtype of this config.",
  6112. enum: ["SUBTYPE_UNSPECIFIED", "IDENTITY_PLATFORM", "FIREBASE_AUTH"],
  6113. readOnly: true,
  6114. type: "string",
  6115. },
  6116. },
  6117. type: "object",
  6118. },
  6119. GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdp: {
  6120. description: "Standard Identity Toolkit-trusted IDPs.",
  6121. properties: {
  6122. description: { description: "Description of the Idp", type: "string" },
  6123. idpId: { description: "Id the of Idp", type: "string" },
  6124. },
  6125. type: "object",
  6126. },
  6127. GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig: {
  6128. description: "Configurations options for authenticating with a the standard set of Identity Toolkit-trusted IDPs.",
  6129. properties: {
  6130. appleSignInConfig: {
  6131. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2AppleSignInConfig",
  6132. },
  6133. clientId: { description: "OAuth client ID.", type: "string" },
  6134. clientSecret: { description: "OAuth client secret.", type: "string" },
  6135. enabled: {
  6136. description: "True if allows the user to sign in with the provider.",
  6137. type: "boolean",
  6138. },
  6139. name: {
  6140. description: 'The name of the DefaultSupportedIdpConfig resource, for example: "projects/my-awesome-project/defaultSupportedIdpConfigs/google.com"',
  6141. type: "string",
  6142. },
  6143. },
  6144. type: "object",
  6145. },
  6146. GoogleCloudIdentitytoolkitAdminV2DnsInfo: {
  6147. description: "Information of custom domain DNS verification. By default, default_domain will be used. A custom domain can be configured using VerifyCustomDomain.",
  6148. properties: {
  6149. customDomain: {
  6150. description: "Output only. The applied verified custom domain.",
  6151. readOnly: true,
  6152. type: "string",
  6153. },
  6154. customDomainState: {
  6155. description: "Output only. The current verification state of the custom domain. The custom domain will only be used once the domain verification is successful.",
  6156. enum: [
  6157. "VERIFICATION_STATE_UNSPECIFIED",
  6158. "NOT_STARTED",
  6159. "IN_PROGRESS",
  6160. "FAILED",
  6161. "SUCCEEDED",
  6162. ],
  6163. readOnly: true,
  6164. type: "string",
  6165. },
  6166. domainVerificationRequestTime: {
  6167. description: "Output only. The timestamp of initial request for the current domain verification.",
  6168. format: "google-datetime",
  6169. readOnly: true,
  6170. type: "string",
  6171. },
  6172. pendingCustomDomain: {
  6173. description: "Output only. The custom domain that's to be verified.",
  6174. readOnly: true,
  6175. type: "string",
  6176. },
  6177. useCustomDomain: { description: "Whether to use custom domain.", type: "boolean" },
  6178. },
  6179. type: "object",
  6180. },
  6181. GoogleCloudIdentitytoolkitAdminV2Email: {
  6182. description: "Configuration options related to authenticating a user by their email address.",
  6183. properties: {
  6184. enabled: {
  6185. description: "Whether email auth is enabled for the project or not.",
  6186. type: "boolean",
  6187. },
  6188. passwordRequired: {
  6189. description: "Whether a password is required for email auth or not. If true, both an email and password must be provided to sign in. If false, a user may sign in via either email/password or email link.",
  6190. type: "boolean",
  6191. },
  6192. },
  6193. type: "object",
  6194. },
  6195. GoogleCloudIdentitytoolkitAdminV2EmailPrivacyConfig: {
  6196. description: "Configuration for settings related to email privacy and public visibility. Settings in this config protect against email enumeration, but may make some trade-offs in user-friendliness.",
  6197. properties: {
  6198. enableImprovedEmailPrivacy: {
  6199. description: "Migrates the project to a state of improved email privacy. For example certain error codes are more generic to avoid giving away information on whether the account exists. In addition, this disables certain features that as a side-effect allow user enumeration. Enabling this toggle disables the fetchSignInMethodsForEmail functionality and changing the user's email to an unverified email. It is recommended to remove dependence on this functionality and enable this toggle to improve user privacy.",
  6200. type: "boolean",
  6201. },
  6202. },
  6203. type: "object",
  6204. },
  6205. GoogleCloudIdentitytoolkitAdminV2EmailTemplate: {
  6206. description: "Email template. The subject and body fields can contain the following placeholders which will be replaced with the appropriate values: %LINK% - The link to use to redeem the send OOB code. %EMAIL% - The email where the email is being sent. %NEW_EMAIL% - The new email being set for the account (when applicable). %APP_NAME% - The GCP project's display name. %DISPLAY_NAME% - The user's display name.",
  6207. properties: {
  6208. body: { description: "Email body", type: "string" },
  6209. bodyFormat: {
  6210. description: "Email body format",
  6211. enum: ["BODY_FORMAT_UNSPECIFIED", "PLAIN_TEXT", "HTML"],
  6212. type: "string",
  6213. },
  6214. customized: {
  6215. description: "Output only. Whether the body or subject of the email is customized.",
  6216. readOnly: true,
  6217. type: "boolean",
  6218. },
  6219. replyTo: { description: "Reply-to address", type: "string" },
  6220. senderDisplayName: { description: "Sender display name", type: "string" },
  6221. senderLocalPart: { description: "Local part of From address", type: "string" },
  6222. subject: { description: "Subject of the email", type: "string" },
  6223. },
  6224. type: "object",
  6225. },
  6226. GoogleCloudIdentitytoolkitAdminV2ForwardInboundCredentials: {
  6227. description: "Indicates which credentials to pass to the registered Blocking Functions.",
  6228. properties: {
  6229. accessToken: {
  6230. description: "Whether to pass the user's OAuth identity provider's access token.",
  6231. type: "boolean",
  6232. },
  6233. idToken: {
  6234. description: "Whether to pass the user's OIDC identity provider's ID token.",
  6235. type: "boolean",
  6236. },
  6237. refreshToken: {
  6238. description: "Whether to pass the user's OAuth identity provider's refresh token.",
  6239. type: "boolean",
  6240. },
  6241. },
  6242. type: "object",
  6243. },
  6244. GoogleCloudIdentitytoolkitAdminV2HashConfig: {
  6245. description: "History information of the hash algorithm and key. Different accounts' passwords may be generated by different version.",
  6246. properties: {
  6247. algorithm: {
  6248. description: "Output only. Different password hash algorithms used in Identity Toolkit.",
  6249. enum: [
  6250. "HASH_ALGORITHM_UNSPECIFIED",
  6251. "HMAC_SHA256",
  6252. "HMAC_SHA1",
  6253. "HMAC_MD5",
  6254. "SCRYPT",
  6255. "PBKDF_SHA1",
  6256. "MD5",
  6257. "HMAC_SHA512",
  6258. "SHA1",
  6259. "BCRYPT",
  6260. "PBKDF2_SHA256",
  6261. "SHA256",
  6262. "SHA512",
  6263. "STANDARD_SCRYPT",
  6264. ],
  6265. readOnly: true,
  6266. type: "string",
  6267. },
  6268. memoryCost: {
  6269. description: "Output only. Memory cost for hash calculation. Used by scrypt and other similar password derivation algorithms. See https://tools.ietf.org/html/rfc7914 for explanation of field.",
  6270. format: "int32",
  6271. readOnly: true,
  6272. type: "integer",
  6273. },
  6274. rounds: {
  6275. description: "Output only. How many rounds for hash calculation. Used by scrypt and other similar password derivation algorithms.",
  6276. format: "int32",
  6277. readOnly: true,
  6278. type: "integer",
  6279. },
  6280. saltSeparator: {
  6281. description: "Output only. Non-printable character to be inserted between the salt and plain text password in base64.",
  6282. readOnly: true,
  6283. type: "string",
  6284. },
  6285. signerKey: {
  6286. description: "Output only. Signer key in base64.",
  6287. readOnly: true,
  6288. type: "string",
  6289. },
  6290. },
  6291. type: "object",
  6292. },
  6293. GoogleCloudIdentitytoolkitAdminV2IdpCertificate: {
  6294. description: "The IDP's certificate data to verify the signature in the SAMLResponse issued by the IDP.",
  6295. properties: { x509Certificate: { description: "The x509 certificate", type: "string" } },
  6296. type: "object",
  6297. },
  6298. GoogleCloudIdentitytoolkitAdminV2IdpConfig: {
  6299. description: "The SAML IdP (Identity Provider) configuration when the project acts as the relying party.",
  6300. properties: {
  6301. idpCertificates: {
  6302. description: "IDP's public keys for verifying signature in the assertions.",
  6303. items: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2IdpCertificate" },
  6304. type: "array",
  6305. },
  6306. idpEntityId: { description: "Unique identifier for all SAML entities.", type: "string" },
  6307. signRequest: {
  6308. description: "Indicates if outbounding SAMLRequest should be signed.",
  6309. type: "boolean",
  6310. },
  6311. ssoUrl: { description: "URL to send Authentication request to.", type: "string" },
  6312. },
  6313. type: "object",
  6314. },
  6315. GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig: {
  6316. description: "A pair of SAML RP-IDP configurations when the project acts as the relying party.",
  6317. properties: {
  6318. displayName: {
  6319. description: "The config's display name set by developers.",
  6320. type: "string",
  6321. },
  6322. enabled: {
  6323. description: "True if allows the user to sign in with the provider.",
  6324. type: "boolean",
  6325. },
  6326. idpConfig: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2IdpConfig" },
  6327. name: {
  6328. description: "The name of the InboundSamlConfig resource, for example: 'projects/my-awesome-project/inboundSamlConfigs/my-config-id'. Ignored during create requests.",
  6329. type: "string",
  6330. },
  6331. spConfig: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2SpConfig" },
  6332. },
  6333. type: "object",
  6334. },
  6335. GoogleCloudIdentitytoolkitAdminV2Inheritance: {
  6336. description: "Settings that the tenants will inherit from project level.",
  6337. properties: {
  6338. emailSendingConfig: {
  6339. description: "Whether to allow the tenant to inherit custom domains, email templates, and custom SMTP settings. If true, email sent from tenant will follow the project level email sending configurations. If false (by default), emails will go with the default settings with no customizations.",
  6340. type: "boolean",
  6341. },
  6342. },
  6343. type: "object",
  6344. },
  6345. GoogleCloudIdentitytoolkitAdminV2InitializeIdentityPlatformRequest: {
  6346. description: "Request for InitializeIdentityPlatform.",
  6347. properties: {},
  6348. type: "object",
  6349. },
  6350. GoogleCloudIdentitytoolkitAdminV2InitializeIdentityPlatformResponse: {
  6351. description: "Response for InitializeIdentityPlatform. Empty for now.",
  6352. properties: {},
  6353. type: "object",
  6354. },
  6355. GoogleCloudIdentitytoolkitAdminV2ListDefaultSupportedIdpConfigsResponse: {
  6356. description: "Response for DefaultSupportedIdpConfigs",
  6357. properties: {
  6358. defaultSupportedIdpConfigs: {
  6359. description: "The set of configs.",
  6360. items: {
  6361. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig",
  6362. },
  6363. type: "array",
  6364. },
  6365. nextPageToken: {
  6366. description: "Token to retrieve the next page of results, or empty if there are no more results in the list.",
  6367. type: "string",
  6368. },
  6369. },
  6370. type: "object",
  6371. },
  6372. GoogleCloudIdentitytoolkitAdminV2ListDefaultSupportedIdpsResponse: {
  6373. description: "Response for ListDefaultSupportedIdps",
  6374. properties: {
  6375. defaultSupportedIdps: {
  6376. description: "The set of configs.",
  6377. items: {
  6378. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdp",
  6379. },
  6380. type: "array",
  6381. },
  6382. nextPageToken: {
  6383. description: "Token to retrieve the next page of results, or empty if there are no more results in the list.",
  6384. type: "string",
  6385. },
  6386. },
  6387. type: "object",
  6388. },
  6389. GoogleCloudIdentitytoolkitAdminV2ListInboundSamlConfigsResponse: {
  6390. description: "Response for ListInboundSamlConfigs",
  6391. properties: {
  6392. inboundSamlConfigs: {
  6393. description: "The set of configs.",
  6394. items: {
  6395. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig",
  6396. },
  6397. type: "array",
  6398. },
  6399. nextPageToken: {
  6400. description: "Token to retrieve the next page of results, or empty if there are no more results in the list.",
  6401. type: "string",
  6402. },
  6403. },
  6404. type: "object",
  6405. },
  6406. GoogleCloudIdentitytoolkitAdminV2ListOAuthIdpConfigsResponse: {
  6407. description: "Response for ListOAuthIdpConfigs",
  6408. properties: {
  6409. nextPageToken: {
  6410. description: "Token to retrieve the next page of results, or empty if there are no more results in the list.",
  6411. type: "string",
  6412. },
  6413. oauthIdpConfigs: {
  6414. description: "The set of configs.",
  6415. items: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig" },
  6416. type: "array",
  6417. },
  6418. },
  6419. type: "object",
  6420. },
  6421. GoogleCloudIdentitytoolkitAdminV2ListTenantsResponse: {
  6422. description: "Response message for ListTenants.",
  6423. properties: {
  6424. nextPageToken: {
  6425. description: "The token to get the next page of results.",
  6426. type: "string",
  6427. },
  6428. tenants: {
  6429. description: "A list of tenants under the given agent project.",
  6430. items: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2Tenant" },
  6431. type: "array",
  6432. },
  6433. },
  6434. type: "object",
  6435. },
  6436. GoogleCloudIdentitytoolkitAdminV2MonitoringConfig: {
  6437. description: "Configuration related to monitoring project activity.",
  6438. properties: {
  6439. requestLogging: {
  6440. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2RequestLogging",
  6441. },
  6442. },
  6443. type: "object",
  6444. },
  6445. GoogleCloudIdentitytoolkitAdminV2MultiFactorAuthConfig: {
  6446. description: "Options related to MultiFactor Authentication for the project.",
  6447. properties: {
  6448. enabledProviders: {
  6449. description: "A list of usable second factors for this project.",
  6450. items: { enum: ["PROVIDER_UNSPECIFIED", "PHONE_SMS"], type: "string" },
  6451. type: "array",
  6452. },
  6453. state: {
  6454. description: "Whether MultiFactor Authentication has been enabled for this project.",
  6455. enum: ["STATE_UNSPECIFIED", "DISABLED", "ENABLED", "MANDATORY"],
  6456. type: "string",
  6457. },
  6458. },
  6459. type: "object",
  6460. },
  6461. GoogleCloudIdentitytoolkitAdminV2MultiTenantConfig: {
  6462. description: "Configuration related to multi-tenant functionality.",
  6463. properties: {
  6464. allowTenants: {
  6465. description: "Whether this project can have tenants or not.",
  6466. type: "boolean",
  6467. },
  6468. defaultTenantLocation: {
  6469. description: 'The default cloud parent org or folder that the tenant project should be created under. The parent resource name should be in the format of "/", such as "folders/123" or "organizations/456". If the value is not set, the tenant will be created under the same organization or folder as the agent project.',
  6470. type: "string",
  6471. },
  6472. },
  6473. type: "object",
  6474. },
  6475. GoogleCloudIdentitytoolkitAdminV2NotificationConfig: {
  6476. description: "Configuration related to sending notifications to users.",
  6477. properties: {
  6478. defaultLocale: {
  6479. description: "Default locale used for email and SMS in IETF BCP 47 format.",
  6480. type: "string",
  6481. },
  6482. sendEmail: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2SendEmail" },
  6483. sendSms: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2SendSms" },
  6484. },
  6485. type: "object",
  6486. },
  6487. GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig: {
  6488. description: "Configuration options for authenticating with an OAuth IDP.",
  6489. properties: {
  6490. clientId: { description: "The client id of an OAuth client.", type: "string" },
  6491. clientSecret: {
  6492. description: "The client secret of the OAuth client, to enable OIDC code flow.",
  6493. type: "string",
  6494. },
  6495. displayName: {
  6496. description: "The config's display name set by developers.",
  6497. type: "string",
  6498. },
  6499. enabled: {
  6500. description: "True if allows the user to sign in with the provider.",
  6501. type: "boolean",
  6502. },
  6503. issuer: { description: "For OIDC Idps, the issuer identifier.", type: "string" },
  6504. name: {
  6505. description: "The name of the OAuthIdpConfig resource, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. Ignored during create requests.",
  6506. type: "string",
  6507. },
  6508. responseType: {
  6509. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2OAuthResponseType",
  6510. },
  6511. },
  6512. type: "object",
  6513. },
  6514. GoogleCloudIdentitytoolkitAdminV2OAuthResponseType: {
  6515. description: "The response type to request for in the OAuth authorization flow. You can set either `id_token` or `code` to true, but not both. Setting both types to be simultaneously true (`{code: true, id_token: true}`) is not yet supported. See https://openid.net/specs/openid-connect-core-1_0.html#Authentication for a mapping of response type to OAuth 2.0 flow.",
  6516. properties: {
  6517. code: {
  6518. description: "If true, authorization code is returned from IdP's authorization endpoint.",
  6519. type: "boolean",
  6520. },
  6521. idToken: {
  6522. description: "If true, ID token is returned from IdP's authorization endpoint.",
  6523. type: "boolean",
  6524. },
  6525. token: {
  6526. description: "Do not use. The `token` response type is not supported at the moment.",
  6527. type: "boolean",
  6528. },
  6529. },
  6530. type: "object",
  6531. },
  6532. GoogleCloudIdentitytoolkitAdminV2Permissions: {
  6533. description: "Configuration related to restricting a user's ability to affect their account.",
  6534. properties: {
  6535. disabledUserDeletion: {
  6536. description: "When true, end users cannot delete their account on the associated project through any of our API methods",
  6537. type: "boolean",
  6538. },
  6539. disabledUserSignup: {
  6540. description: "When true, end users cannot sign up for a new account on the associated project through any of our API methods",
  6541. type: "boolean",
  6542. },
  6543. },
  6544. type: "object",
  6545. },
  6546. GoogleCloudIdentitytoolkitAdminV2PhoneNumber: {
  6547. description: "Configuration options related to authenticated a user by their phone number.",
  6548. properties: {
  6549. enabled: {
  6550. description: "Whether phone number auth is enabled for the project or not.",
  6551. type: "boolean",
  6552. },
  6553. testPhoneNumbers: {
  6554. additionalProperties: { type: "string" },
  6555. description: "A map of that can be used for phone auth testing.",
  6556. type: "object",
  6557. },
  6558. },
  6559. type: "object",
  6560. },
  6561. GoogleCloudIdentitytoolkitAdminV2QuotaConfig: {
  6562. description: "Configuration related to quotas.",
  6563. properties: {
  6564. signUpQuotaConfig: {
  6565. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2TemporaryQuota",
  6566. },
  6567. },
  6568. type: "object",
  6569. },
  6570. GoogleCloudIdentitytoolkitAdminV2RequestLogging: {
  6571. description: "Configuration for logging requests made to this project to Stackdriver Logging",
  6572. properties: {
  6573. enabled: {
  6574. description: "Whether logging is enabled for this project or not.",
  6575. type: "boolean",
  6576. },
  6577. },
  6578. type: "object",
  6579. },
  6580. GoogleCloudIdentitytoolkitAdminV2SendEmail: {
  6581. description: "Options for email sending.",
  6582. properties: {
  6583. callbackUri: { description: "action url in email template.", type: "string" },
  6584. changeEmailTemplate: {
  6585. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2EmailTemplate",
  6586. },
  6587. dnsInfo: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2DnsInfo" },
  6588. legacyResetPasswordTemplate: {
  6589. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2EmailTemplate",
  6590. },
  6591. method: {
  6592. description: "The method used for sending an email.",
  6593. enum: ["METHOD_UNSPECIFIED", "DEFAULT", "CUSTOM_SMTP"],
  6594. type: "string",
  6595. },
  6596. resetPasswordTemplate: {
  6597. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2EmailTemplate",
  6598. },
  6599. revertSecondFactorAdditionTemplate: {
  6600. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2EmailTemplate",
  6601. },
  6602. smtp: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2Smtp" },
  6603. verifyEmailTemplate: {
  6604. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2EmailTemplate",
  6605. },
  6606. },
  6607. type: "object",
  6608. },
  6609. GoogleCloudIdentitytoolkitAdminV2SendSms: {
  6610. description: "Options for SMS sending.",
  6611. properties: {
  6612. smsTemplate: {
  6613. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2SmsTemplate",
  6614. },
  6615. useDeviceLocale: {
  6616. description: "Whether to use the accept_language header for SMS.",
  6617. type: "boolean",
  6618. },
  6619. },
  6620. type: "object",
  6621. },
  6622. GoogleCloudIdentitytoolkitAdminV2SignInConfig: {
  6623. description: "Configuration related to local sign in methods.",
  6624. properties: {
  6625. allowDuplicateEmails: {
  6626. description: "Whether to allow more than one account to have the same email.",
  6627. type: "boolean",
  6628. },
  6629. anonymous: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2Anonymous" },
  6630. email: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2Email" },
  6631. hashConfig: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2HashConfig" },
  6632. phoneNumber: {
  6633. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2PhoneNumber",
  6634. },
  6635. },
  6636. type: "object",
  6637. },
  6638. GoogleCloudIdentitytoolkitAdminV2SmsRegionConfig: {
  6639. description: "Configures the regions where users are allowed to send verification SMS for the project or tenant. This is based on the calling code of the destination phone number.",
  6640. properties: {
  6641. allowByDefault: {
  6642. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2AllowByDefault",
  6643. },
  6644. allowlistOnly: {
  6645. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2AllowlistOnly",
  6646. },
  6647. },
  6648. type: "object",
  6649. },
  6650. GoogleCloudIdentitytoolkitAdminV2SmsTemplate: {
  6651. description: "The template to use when sending an SMS.",
  6652. properties: {
  6653. content: {
  6654. description: "Output only. The SMS's content. Can contain the following placeholders which will be replaced with the appropriate values: %APP_NAME% - For Android or iOS apps, the app's display name. For web apps, the domain hosting the application. %LOGIN_CODE% - The OOB code being sent in the SMS.",
  6655. readOnly: true,
  6656. type: "string",
  6657. },
  6658. },
  6659. type: "object",
  6660. },
  6661. GoogleCloudIdentitytoolkitAdminV2Smtp: {
  6662. description: "Configuration for SMTP relay",
  6663. properties: {
  6664. host: { description: "SMTP relay host", type: "string" },
  6665. password: { description: "SMTP relay password", type: "string" },
  6666. port: { description: "SMTP relay port", format: "int32", type: "integer" },
  6667. securityMode: {
  6668. description: "SMTP security mode.",
  6669. enum: ["SECURITY_MODE_UNSPECIFIED", "SSL", "START_TLS"],
  6670. type: "string",
  6671. },
  6672. senderEmail: { description: "Sender email for the SMTP relay", type: "string" },
  6673. username: { description: "SMTP relay username", type: "string" },
  6674. },
  6675. type: "object",
  6676. },
  6677. GoogleCloudIdentitytoolkitAdminV2SpCertificate: {
  6678. description: "The SP's certificate data for IDP to verify the SAMLRequest generated by the SP.",
  6679. properties: {
  6680. expiresAt: {
  6681. description: "Timestamp of the cert expiration instance.",
  6682. format: "google-datetime",
  6683. type: "string",
  6684. },
  6685. x509Certificate: { description: "Self-signed public certificate.", type: "string" },
  6686. },
  6687. type: "object",
  6688. },
  6689. GoogleCloudIdentitytoolkitAdminV2SpConfig: {
  6690. description: "The SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider.",
  6691. properties: {
  6692. callbackUri: {
  6693. description: "Callback URI where responses from IDP are handled.",
  6694. type: "string",
  6695. },
  6696. spCertificates: {
  6697. description: "Output only. Public certificates generated by the server to verify the signature in SAMLRequest in the SP-initiated flow.",
  6698. items: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2SpCertificate" },
  6699. readOnly: true,
  6700. type: "array",
  6701. },
  6702. spEntityId: { description: "Unique identifier for all SAML entities.", type: "string" },
  6703. },
  6704. type: "object",
  6705. },
  6706. GoogleCloudIdentitytoolkitAdminV2TemporaryQuota: {
  6707. description: "Temporary quota increase / decrease",
  6708. properties: {
  6709. quota: {
  6710. description: "Corresponds to the 'refill_token_count' field in QuotaServer config",
  6711. format: "int64",
  6712. type: "string",
  6713. },
  6714. quotaDuration: {
  6715. description: "How long this quota will be active for",
  6716. format: "google-duration",
  6717. type: "string",
  6718. },
  6719. startTime: {
  6720. description: "When this quota will take affect",
  6721. format: "google-datetime",
  6722. type: "string",
  6723. },
  6724. },
  6725. type: "object",
  6726. },
  6727. GoogleCloudIdentitytoolkitAdminV2Tenant: {
  6728. description: "A Tenant contains configuration for the tenant in a multi-tenant project.",
  6729. properties: {
  6730. allowPasswordSignup: {
  6731. description: "Whether to allow email/password user authentication.",
  6732. type: "boolean",
  6733. },
  6734. autodeleteAnonymousUsers: {
  6735. description: "Whether anonymous users will be auto-deleted after a period of 30 days.",
  6736. type: "boolean",
  6737. },
  6738. client: {
  6739. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2ClientPermissionConfig",
  6740. },
  6741. disableAuth: {
  6742. description: "Whether authentication is disabled for the tenant. If true, the users under the disabled tenant are not allowed to sign-in. Admins of the disabled tenant are not able to manage its users.",
  6743. type: "boolean",
  6744. },
  6745. displayName: { description: "Display name of the tenant.", type: "string" },
  6746. emailPrivacyConfig: {
  6747. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2EmailPrivacyConfig",
  6748. },
  6749. enableAnonymousUser: {
  6750. description: "Whether to enable anonymous user authentication.",
  6751. type: "boolean",
  6752. },
  6753. enableEmailLinkSignin: {
  6754. description: "Whether to enable email link user authentication.",
  6755. type: "boolean",
  6756. },
  6757. hashConfig: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2HashConfig" },
  6758. inheritance: {
  6759. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2Inheritance",
  6760. },
  6761. mfaConfig: {
  6762. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2MultiFactorAuthConfig",
  6763. },
  6764. monitoring: {
  6765. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2MonitoringConfig",
  6766. },
  6767. name: {
  6768. description: 'Output only. Resource name of a tenant. For example: "projects/{project-id}/tenants/{tenant-id}"',
  6769. readOnly: true,
  6770. type: "string",
  6771. },
  6772. smsRegionConfig: {
  6773. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2SmsRegionConfig",
  6774. },
  6775. testPhoneNumbers: {
  6776. additionalProperties: { type: "string" },
  6777. description: "A map of pairs that can be used for MFA. The phone number should be in E.164 format (https://www.itu.int/rec/T-REC-E.164/) and a maximum of 10 pairs can be added (error will be thrown once exceeded).",
  6778. type: "object",
  6779. },
  6780. },
  6781. type: "object",
  6782. },
  6783. GoogleCloudIdentitytoolkitAdminV2Trigger: {
  6784. description: "Synchronous Cloud Function with HTTP Trigger",
  6785. properties: {
  6786. functionUri: { description: "HTTP URI trigger for the Cloud Function.", type: "string" },
  6787. updateTime: {
  6788. description: "When the trigger was changed.",
  6789. format: "google-datetime",
  6790. type: "string",
  6791. },
  6792. },
  6793. type: "object",
  6794. },
  6795. GoogleCloudIdentitytoolkitV2AutoRetrievalInfo: {
  6796. description: "The information required to auto-retrieve an SMS.",
  6797. properties: {
  6798. appSignatureHash: {
  6799. description: "The Android app's signature hash for Google Play Service's SMS Retriever API.",
  6800. type: "string",
  6801. },
  6802. },
  6803. type: "object",
  6804. },
  6805. GoogleCloudIdentitytoolkitV2FinalizeMfaEnrollmentRequest: {
  6806. description: "Finishes enrolling a second factor for the user.",
  6807. properties: {
  6808. displayName: {
  6809. description: "Display name which is entered by users to distinguish between different second factors with same type or different type.",
  6810. type: "string",
  6811. },
  6812. idToken: { description: "Required. ID token.", type: "string" },
  6813. phoneVerificationInfo: {
  6814. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV2FinalizeMfaPhoneRequestInfo",
  6815. },
  6816. tenantId: {
  6817. description: "The ID of the Identity Platform tenant that the user enrolling MFA belongs to. If not set, the user belongs to the default Identity Platform project.",
  6818. type: "string",
  6819. },
  6820. },
  6821. type: "object",
  6822. },
  6823. GoogleCloudIdentitytoolkitV2FinalizeMfaEnrollmentResponse: {
  6824. description: "FinalizeMfaEnrollment response.",
  6825. properties: {
  6826. idToken: { description: "ID token updated to reflect MFA enrollment.", type: "string" },
  6827. phoneAuthInfo: {
  6828. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV2FinalizeMfaPhoneResponseInfo",
  6829. },
  6830. refreshToken: {
  6831. description: "Refresh token updated to reflect MFA enrollment.",
  6832. type: "string",
  6833. },
  6834. },
  6835. type: "object",
  6836. },
  6837. GoogleCloudIdentitytoolkitV2FinalizeMfaPhoneRequestInfo: {
  6838. description: "Phone Verification info for a FinalizeMfa request.",
  6839. properties: {
  6840. androidVerificationProof: {
  6841. description: 'Android only. Uses for "instant" phone number verification though GmsCore.',
  6842. type: "string",
  6843. },
  6844. code: { description: "User-entered verification code.", type: "string" },
  6845. phoneNumber: {
  6846. description: "Required if Android verification proof is presented.",
  6847. type: "string",
  6848. },
  6849. sessionInfo: {
  6850. description: "An opaque string that represents the enrollment session.",
  6851. type: "string",
  6852. },
  6853. },
  6854. type: "object",
  6855. },
  6856. GoogleCloudIdentitytoolkitV2FinalizeMfaPhoneResponseInfo: {
  6857. description: "Phone Verification info for a FinalizeMfa response.",
  6858. properties: {
  6859. androidVerificationProof: {
  6860. description: "Android only. Long-lived replacement for valid code tied to android device.",
  6861. type: "string",
  6862. },
  6863. androidVerificationProofExpireTime: {
  6864. description: "Android only. Expiration time of verification proof in seconds.",
  6865. format: "google-datetime",
  6866. type: "string",
  6867. },
  6868. phoneNumber: { description: "For Android verification proof.", type: "string" },
  6869. },
  6870. type: "object",
  6871. },
  6872. GoogleCloudIdentitytoolkitV2FinalizeMfaSignInRequest: {
  6873. description: "Finalizes sign-in by verifying MFA challenge.",
  6874. properties: {
  6875. mfaPendingCredential: {
  6876. description: "Required. Pending credential from first factor sign-in.",
  6877. type: "string",
  6878. },
  6879. phoneVerificationInfo: {
  6880. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV2FinalizeMfaPhoneRequestInfo",
  6881. },
  6882. tenantId: {
  6883. description: "The ID of the Identity Platform tenant the user is signing in to. If not set, the user will sign in to the default Identity Platform project.",
  6884. type: "string",
  6885. },
  6886. },
  6887. type: "object",
  6888. },
  6889. GoogleCloudIdentitytoolkitV2FinalizeMfaSignInResponse: {
  6890. description: "FinalizeMfaSignIn response.",
  6891. properties: {
  6892. idToken: { description: "ID token for the authenticated user.", type: "string" },
  6893. phoneAuthInfo: {
  6894. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV2FinalizeMfaPhoneResponseInfo",
  6895. },
  6896. refreshToken: {
  6897. description: "Refresh token for the authenticated user.",
  6898. type: "string",
  6899. },
  6900. },
  6901. type: "object",
  6902. },
  6903. GoogleCloudIdentitytoolkitV2StartMfaEnrollmentRequest: {
  6904. description: "Sends MFA enrollment verification SMS for a user.",
  6905. properties: {
  6906. idToken: { description: "Required. User's ID token.", type: "string" },
  6907. phoneEnrollmentInfo: {
  6908. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV2StartMfaPhoneRequestInfo",
  6909. },
  6910. tenantId: {
  6911. description: "The ID of the Identity Platform tenant that the user enrolling MFA belongs to. If not set, the user belongs to the default Identity Platform project.",
  6912. type: "string",
  6913. },
  6914. },
  6915. type: "object",
  6916. },
  6917. GoogleCloudIdentitytoolkitV2StartMfaEnrollmentResponse: {
  6918. description: "StartMfaEnrollment response.",
  6919. properties: {
  6920. phoneSessionInfo: {
  6921. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV2StartMfaPhoneResponseInfo",
  6922. },
  6923. },
  6924. type: "object",
  6925. },
  6926. GoogleCloudIdentitytoolkitV2StartMfaPhoneRequestInfo: {
  6927. description: "App Verification info for a StartMfa request.",
  6928. properties: {
  6929. autoRetrievalInfo: {
  6930. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV2AutoRetrievalInfo",
  6931. },
  6932. iosReceipt: {
  6933. description: "iOS only. Receipt of successful app token validation with APNS.",
  6934. type: "string",
  6935. },
  6936. iosSecret: {
  6937. description: "iOS only. Secret delivered to iOS app via APNS.",
  6938. type: "string",
  6939. },
  6940. phoneNumber: {
  6941. description: "Required for enrollment. Phone number to be enrolled as MFA.",
  6942. type: "string",
  6943. },
  6944. recaptchaToken: { description: "Web only. Recaptcha solution.", type: "string" },
  6945. safetyNetToken: {
  6946. description: "Android only. Used to assert application identity in place of a recaptcha token. A SafetyNet Token can be generated via the [SafetyNet Android Attestation API](https://developer.android.com/training/safetynet/attestation.html), with the Base64 encoding of the `phone_number` field as the nonce.",
  6947. type: "string",
  6948. },
  6949. },
  6950. type: "object",
  6951. },
  6952. GoogleCloudIdentitytoolkitV2StartMfaPhoneResponseInfo: {
  6953. description: "Phone Verification info for a StartMfa response.",
  6954. properties: {
  6955. sessionInfo: {
  6956. description: "An opaque string that represents the enrollment session.",
  6957. type: "string",
  6958. },
  6959. },
  6960. type: "object",
  6961. },
  6962. GoogleCloudIdentitytoolkitV2StartMfaSignInRequest: {
  6963. description: "Starts multi-factor sign-in by sending the multi-factor auth challenge.",
  6964. properties: {
  6965. mfaEnrollmentId: {
  6966. description: "Required. MFA enrollment id from the user's list of current MFA enrollments.",
  6967. type: "string",
  6968. },
  6969. mfaPendingCredential: {
  6970. description: "Required. Pending credential from first factor sign-in.",
  6971. type: "string",
  6972. },
  6973. phoneSignInInfo: {
  6974. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV2StartMfaPhoneRequestInfo",
  6975. },
  6976. tenantId: {
  6977. description: "The ID of the Identity Platform tenant the user is signing in to. If not set, the user will sign in to the default Identity Platform project.",
  6978. type: "string",
  6979. },
  6980. },
  6981. type: "object",
  6982. },
  6983. GoogleCloudIdentitytoolkitV2StartMfaSignInResponse: {
  6984. description: "StartMfaSignIn response.",
  6985. properties: {
  6986. phoneResponseInfo: {
  6987. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV2StartMfaPhoneResponseInfo",
  6988. },
  6989. },
  6990. type: "object",
  6991. },
  6992. GoogleCloudIdentitytoolkitV2WithdrawMfaRequest: {
  6993. description: "Withdraws MFA.",
  6994. properties: {
  6995. idToken: { description: "Required. User's ID token.", type: "string" },
  6996. mfaEnrollmentId: {
  6997. description: "Required. MFA enrollment id from a current MFA enrollment.",
  6998. type: "string",
  6999. },
  7000. tenantId: {
  7001. description: "The ID of the Identity Platform tenant that the user unenrolling MFA belongs to. If not set, the user belongs to the default Identity Platform project.",
  7002. type: "string",
  7003. },
  7004. },
  7005. type: "object",
  7006. },
  7007. GoogleCloudIdentitytoolkitV2WithdrawMfaResponse: {
  7008. description: "Withdraws MultiFactorAuth response.",
  7009. properties: {
  7010. idToken: {
  7011. description: "ID token updated to reflect removal of the second factor.",
  7012. type: "string",
  7013. },
  7014. refreshToken: {
  7015. description: "Refresh token updated to reflect removal of the second factor.",
  7016. type: "string",
  7017. },
  7018. },
  7019. type: "object",
  7020. },
  7021. GoogleIamV1AuditConfig: {
  7022. description: 'Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.',
  7023. properties: {
  7024. auditLogConfigs: {
  7025. description: "The configuration for logging of each type of permission.",
  7026. items: { $ref: "#/components/schemas/GoogleIamV1AuditLogConfig" },
  7027. type: "array",
  7028. },
  7029. service: {
  7030. description: "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.",
  7031. type: "string",
  7032. },
  7033. },
  7034. type: "object",
  7035. },
  7036. GoogleIamV1AuditLogConfig: {
  7037. description: 'Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables \'DATA_READ\' and \'DATA_WRITE\' logging, while exempting jose@example.com from DATA_READ logging.',
  7038. properties: {
  7039. exemptedMembers: {
  7040. description: "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.",
  7041. items: { type: "string" },
  7042. type: "array",
  7043. },
  7044. logType: {
  7045. description: "The log type that this config enables.",
  7046. enum: ["LOG_TYPE_UNSPECIFIED", "ADMIN_READ", "DATA_WRITE", "DATA_READ"],
  7047. type: "string",
  7048. },
  7049. },
  7050. type: "object",
  7051. },
  7052. GoogleIamV1Binding: {
  7053. description: "Associates `members`, or principals, with a `role`.",
  7054. properties: {
  7055. condition: { $ref: "#/components/schemas/GoogleTypeExpr" },
  7056. members: {
  7057. description: "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
  7058. items: { type: "string" },
  7059. type: "array",
  7060. },
  7061. role: {
  7062. description: "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
  7063. type: "string",
  7064. },
  7065. },
  7066. type: "object",
  7067. },
  7068. GoogleIamV1GetIamPolicyRequest: {
  7069. description: "Request message for `GetIamPolicy` method.",
  7070. properties: { options: { $ref: "#/components/schemas/GoogleIamV1GetPolicyOptions" } },
  7071. type: "object",
  7072. },
  7073. GoogleIamV1GetPolicyOptions: {
  7074. description: "Encapsulates settings provided to GetIamPolicy.",
  7075. properties: {
  7076. requestedPolicyVersion: {
  7077. description: "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
  7078. format: "int32",
  7079. type: "integer",
  7080. },
  7081. },
  7082. type: "object",
  7083. },
  7084. GoogleIamV1Policy: {
  7085. description: 'An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp(\'2020-10-01T00:00:00.000Z\')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(\'2020-10-01T00:00:00.000Z\') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).',
  7086. properties: {
  7087. auditConfigs: {
  7088. description: "Specifies cloud audit logging configuration for this policy.",
  7089. items: { $ref: "#/components/schemas/GoogleIamV1AuditConfig" },
  7090. type: "array",
  7091. },
  7092. bindings: {
  7093. description: "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
  7094. items: { $ref: "#/components/schemas/GoogleIamV1Binding" },
  7095. type: "array",
  7096. },
  7097. etag: {
  7098. description: "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.",
  7099. format: "byte",
  7100. type: "string",
  7101. },
  7102. version: {
  7103. description: "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
  7104. format: "int32",
  7105. type: "integer",
  7106. },
  7107. },
  7108. type: "object",
  7109. },
  7110. GoogleIamV1SetIamPolicyRequest: {
  7111. description: "Request message for `SetIamPolicy` method.",
  7112. properties: {
  7113. policy: { $ref: "#/components/schemas/GoogleIamV1Policy" },
  7114. updateMask: {
  7115. description: 'OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`',
  7116. format: "google-fieldmask",
  7117. type: "string",
  7118. },
  7119. },
  7120. type: "object",
  7121. },
  7122. GoogleIamV1TestIamPermissionsRequest: {
  7123. description: "Request message for `TestIamPermissions` method.",
  7124. properties: {
  7125. permissions: {
  7126. description: "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
  7127. items: { type: "string" },
  7128. type: "array",
  7129. },
  7130. },
  7131. type: "object",
  7132. },
  7133. GoogleIamV1TestIamPermissionsResponse: {
  7134. description: "Response message for `TestIamPermissions` method.",
  7135. properties: {
  7136. permissions: {
  7137. description: "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
  7138. items: { type: "string" },
  7139. type: "array",
  7140. },
  7141. },
  7142. type: "object",
  7143. },
  7144. GoogleProtobufEmpty: {
  7145. description: "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
  7146. properties: {},
  7147. type: "object",
  7148. },
  7149. GoogleTypeExpr: {
  7150. description: 'Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != \'private\' && document.type != \'internal\'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "\'New message received at \' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.',
  7151. properties: {
  7152. description: {
  7153. description: "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
  7154. type: "string",
  7155. },
  7156. expression: {
  7157. description: "Textual representation of an expression in Common Expression Language syntax.",
  7158. type: "string",
  7159. },
  7160. location: {
  7161. description: "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
  7162. type: "string",
  7163. },
  7164. title: {
  7165. description: "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.",
  7166. type: "string",
  7167. },
  7168. },
  7169. type: "object",
  7170. },
  7171. GrantTokenRequest: {
  7172. properties: {
  7173. code: {
  7174. description: "ID token to exchange for an access token and a refresh token. This field is called `code` to conform with the OAuth 2.0 specification. This field is deprecated and is ignored.",
  7175. type: "string",
  7176. },
  7177. grantType: {
  7178. description: "The grant_types that are supported: - `refresh_token` to exchange a Identity Platform refresh_token for Identity Platform id_token/access_token and possibly a new Identity Platform refresh_token.",
  7179. type: "string",
  7180. },
  7181. refreshToken: {
  7182. description: "Identity Platform refresh_token. This field is ignored if `grantType` isn't `refresh_token`.",
  7183. type: "string",
  7184. },
  7185. },
  7186. type: "object",
  7187. },
  7188. GrantTokenResponse: {
  7189. properties: {
  7190. access_token: { description: "DEPRECATED The granted access token.", type: "string" },
  7191. expires_in: {
  7192. description: "Expiration time of `access_token` in seconds.",
  7193. format: "int64",
  7194. type: "string",
  7195. },
  7196. id_token: { description: "The granted ID token", type: "string" },
  7197. project_id: {
  7198. description: "The client's project number",
  7199. format: "int64",
  7200. type: "string",
  7201. },
  7202. refresh_token: {
  7203. description: "The granted refresh token; might be the same as `refreshToken` in the request.",
  7204. type: "string",
  7205. },
  7206. token_type: {
  7207. description: "The type of `access_token`. Included to conform with the OAuth 2.0 specification; always `Bearer`.",
  7208. type: "string",
  7209. },
  7210. user_id: { description: "The local user ID", type: "string" },
  7211. },
  7212. type: "object",
  7213. },
  7214. EmulatorV1ProjectsConfig: {
  7215. type: "object",
  7216. description: "Emulator-specific configuration.",
  7217. properties: {
  7218. signIn: { properties: { allowDuplicateEmails: { type: "boolean" } }, type: "object" },
  7219. },
  7220. },
  7221. EmulatorV1ProjectsOobCodes: {
  7222. type: "object",
  7223. description: "Details of all pending confirmation codes.",
  7224. properties: {
  7225. oobCodes: {
  7226. type: "array",
  7227. items: {
  7228. type: "object",
  7229. properties: {
  7230. email: { type: "string" },
  7231. oobCode: { type: "string" },
  7232. oobLink: { type: "string" },
  7233. requestType: { type: "string" },
  7234. },
  7235. },
  7236. },
  7237. },
  7238. },
  7239. EmulatorV1ProjectsVerificationCodes: {
  7240. type: "object",
  7241. description: "Details of all pending verification codes.",
  7242. properties: {
  7243. verificationCodes: {
  7244. type: "array",
  7245. items: {
  7246. type: "object",
  7247. properties: {
  7248. code: { type: "string" },
  7249. phoneNumber: { type: "string" },
  7250. sessionInfo: { type: "string" },
  7251. },
  7252. },
  7253. },
  7254. },
  7255. },
  7256. },
  7257. parameters: {
  7258. access_token: {
  7259. name: "access_token",
  7260. in: "query",
  7261. description: "OAuth access token.",
  7262. schema: { type: "string" },
  7263. },
  7264. alt: {
  7265. name: "alt",
  7266. in: "query",
  7267. description: "Data format for response.",
  7268. schema: { type: "string", enum: ["json", "media", "proto"], default: "json" },
  7269. },
  7270. callback: { name: "callback", in: "query", description: "JSONP", schema: { type: "string" } },
  7271. fields: {
  7272. name: "fields",
  7273. in: "query",
  7274. description: "Selector specifying which fields to include in a partial response.",
  7275. schema: { type: "string" },
  7276. },
  7277. oauth_token: {
  7278. name: "oauth_token",
  7279. in: "query",
  7280. description: "OAuth 2.0 token for the current user.",
  7281. schema: { type: "string" },
  7282. },
  7283. prettyPrint: {
  7284. name: "prettyPrint",
  7285. in: "query",
  7286. description: "Returns response with indentations and line breaks.",
  7287. schema: { type: "boolean", default: true },
  7288. },
  7289. quotaUser: {
  7290. name: "quotaUser",
  7291. in: "query",
  7292. description: "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
  7293. schema: { type: "string" },
  7294. },
  7295. uploadType: {
  7296. name: "uploadType",
  7297. in: "query",
  7298. description: 'Legacy upload protocol for media (e.g. "media", "multipart").',
  7299. schema: { type: "string" },
  7300. },
  7301. upload_protocol: {
  7302. name: "upload_protocol",
  7303. in: "query",
  7304. description: 'Upload protocol for media (e.g. "raw", "multipart").',
  7305. schema: { type: "string" },
  7306. },
  7307. },
  7308. requestBodies: {
  7309. GoogleCloudIdentitytoolkitV1BatchDeleteAccountsRequest: {
  7310. content: {
  7311. "application/json": {
  7312. schema: {
  7313. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1BatchDeleteAccountsRequest",
  7314. },
  7315. },
  7316. },
  7317. },
  7318. GoogleCloudIdentitytoolkitV1SignUpRequest: {
  7319. content: {
  7320. "application/json": {
  7321. schema: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignUpRequest" },
  7322. },
  7323. },
  7324. },
  7325. GoogleCloudIdentitytoolkitV1DeleteAccountRequest: {
  7326. content: {
  7327. "application/json": {
  7328. schema: {
  7329. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1DeleteAccountRequest",
  7330. },
  7331. },
  7332. },
  7333. },
  7334. GoogleCloudIdentitytoolkitV1UploadAccountRequest: {
  7335. content: {
  7336. "application/json": {
  7337. schema: {
  7338. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1UploadAccountRequest",
  7339. },
  7340. },
  7341. },
  7342. },
  7343. GoogleCloudIdentitytoolkitV1CreateSessionCookieRequest: {
  7344. content: {
  7345. "application/json": {
  7346. schema: {
  7347. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1CreateSessionCookieRequest",
  7348. },
  7349. },
  7350. },
  7351. },
  7352. GoogleCloudIdentitytoolkitV1GetAccountInfoRequest: {
  7353. content: {
  7354. "application/json": {
  7355. schema: {
  7356. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1GetAccountInfoRequest",
  7357. },
  7358. },
  7359. },
  7360. },
  7361. GoogleCloudIdentitytoolkitV1GetOobCodeRequest: {
  7362. content: {
  7363. "application/json": {
  7364. schema: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1GetOobCodeRequest" },
  7365. },
  7366. },
  7367. },
  7368. GoogleCloudIdentitytoolkitV1SetAccountInfoRequest: {
  7369. content: {
  7370. "application/json": {
  7371. schema: {
  7372. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SetAccountInfoRequest",
  7373. },
  7374. },
  7375. },
  7376. },
  7377. GoogleCloudIdentitytoolkitV1QueryUserInfoRequest: {
  7378. content: {
  7379. "application/json": {
  7380. schema: {
  7381. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1QueryUserInfoRequest",
  7382. },
  7383. },
  7384. },
  7385. },
  7386. GoogleCloudIdentitytoolkitAdminV2Tenant: {
  7387. content: {
  7388. "application/json": {
  7389. schema: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2Tenant" },
  7390. },
  7391. },
  7392. },
  7393. GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig: {
  7394. content: {
  7395. "application/json": {
  7396. schema: {
  7397. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2InboundSamlConfig",
  7398. },
  7399. },
  7400. },
  7401. },
  7402. GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig: {
  7403. content: {
  7404. "application/json": {
  7405. schema: {
  7406. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2DefaultSupportedIdpConfig",
  7407. },
  7408. },
  7409. },
  7410. },
  7411. GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig: {
  7412. content: {
  7413. "application/json": {
  7414. schema: {
  7415. $ref: "#/components/schemas/GoogleCloudIdentitytoolkitAdminV2OAuthIdpConfig",
  7416. },
  7417. },
  7418. },
  7419. },
  7420. },
  7421. securitySchemes: {
  7422. Oauth2: {
  7423. type: "oauth2",
  7424. description: "Oauth 2.0 implicit authentication",
  7425. flows: {
  7426. implicit: {
  7427. authorizationUrl: "https://accounts.google.com/o/oauth2/auth",
  7428. scopes: {
  7429. "https://www.googleapis.com/auth/cloud-platform": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.",
  7430. "https://www.googleapis.com/auth/firebase": "View and administer all your Firebase data and settings",
  7431. },
  7432. },
  7433. authorizationCode: {
  7434. authorizationUrl: "https://accounts.google.com/o/oauth2/auth",
  7435. tokenUrl: "https://accounts.google.com/o/oauth2/token",
  7436. scopes: {
  7437. "https://www.googleapis.com/auth/cloud-platform": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.",
  7438. "https://www.googleapis.com/auth/firebase": "View and administer all your Firebase data and settings",
  7439. },
  7440. },
  7441. },
  7442. },
  7443. apiKeyQuery: {
  7444. type: "apiKey",
  7445. name: "key",
  7446. in: "query",
  7447. description: "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
  7448. },
  7449. apiKeyHeader: {
  7450. type: "apiKey",
  7451. name: "x-goog-api-key",
  7452. in: "header",
  7453. description: "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
  7454. },
  7455. },
  7456. },
  7457. };